Composite¶

class torchrl.data.Composite(*args, **kwargs)[source]¶

A composition of TensorSpecs.

If a TensorSpec is the set-description of Tensor category, the Composite class is akin to the TensorDict class. Like TensorDict, it has a shape (akin to the TensorDict’s batch_size) and an optional device.

引數:

*args – if an unnamed argument is passed, it must be a dictionary with keys matching the expected keys to be found in the Composite object. This is useful to build nested CompositeSpecs with tuple indices.
**kwargs (key (str) – value (TensorSpec)): dictionary of tensorspecs to be stored. Values can be None, in which case is_in will be assumed to be True for the corresponding tensors, and project() will have no effect. spec.encode cannot be used with missing values.

變數:

device (torch.device or None) – if not specified, the device of the composite spec is None (as it is the case for TensorDicts). A non-none device constraints all leaves to be of the same device. On the other hand, a None device allows leaves to have different devices. Defaults to None.
shape (torch.Size) – the leading shape of all the leaves. Equivalent to the batch-size of the corresponding tensordicts.
data_cls (type, optional) – the tensordict subclass (TensorDict, TensorClass, tensorclass…) that should be enforced in the env. Defaults to None.
step_mdp_static (bool, optional) – whether the spec is static under step_mdp. Defaults to False. Defining a Composite as a step_mdp_static spec will make it so that the entire related TensorDict/TensorClass instance is copied during calls to step_mdp - and not updated in-place.

示例

>>> pixels_spec = Bounded(
...     low=torch.zeros(4, 3, 32, 32),
...     high=torch.ones(4, 3, 32, 32),
...     dtype=torch.uint8
... )
>>> observation_vector_spec = Bounded(
...     low=torch.zeros(4, 33),
...     high=torch.ones(4, 33),
...     dtype=torch.float)
>>> composite_spec = Composite(
...     pixels=pixels_spec,
...     observation_vector=observation_vector_spec,
...     shape=(4,)
... )
>>> composite_spec
Composite(
    pixels: BoundedDiscrete(
        shape=torch.Size([4, 3, 32, 32]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([4, 3, 32, 32]), device=cpu, dtype=torch.uint8, contiguous=True),
            high=Tensor(shape=torch.Size([4, 3, 32, 32]), device=cpu, dtype=torch.uint8, contiguous=True)),
        device=cpu,
        dtype=torch.uint8,
        domain=discrete),
    observation_vector: BoundedContinuous(
        shape=torch.Size([4, 33]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([4, 33]), device=cpu, dtype=torch.float32, contiguous=True),
            high=Tensor(shape=torch.Size([4, 33]), device=cpu, dtype=torch.float32, contiguous=True)),
        device=cpu,
        dtype=torch.float32,
        domain=continuous),
    device=None,
    shape=torch.Size([4]))
>>> td = composite_spec.rand()
>>> td
TensorDict(
    fields={
        observation_vector: Tensor(shape=torch.Size([4, 33]), device=cpu, dtype=torch.float32, is_shared=False),
        pixels: Tensor(shape=torch.Size([4, 3, 32, 32]), device=cpu, dtype=torch.uint8, is_shared=False)},
    batch_size=torch.Size([4]),
    device=None,
    is_shared=False)
>>> # we can build a nested composite spec using unnamed arguments
>>> print(Composite({("a", "b"): None, ("a", "c"): None}))
Composite(
    a: Composite(
        b: None,
        c: None,
        device=None,
        shape=torch.Size([])),
    device=None,
    shape=torch.Size([]))

assert_is_in(value: Tensor) → None¶

斷言一個張量是否屬於該區域（box），否則丟擲異常。

引數:: value (torch.Tensor) – 要檢查的值。

cardinality() → int[source]¶

規格的基數。

這指的是規格中可能出現的結果的數量。假設複合規格的基數是所有可能結果的笛卡爾積。

clear_device_()[source]¶: 清除 Composite 的裝置。

clone() → Composite[source]¶

克隆 Composite spec。

鎖定的 spec 不會產生鎖定的克隆。

contains(item: torch.Tensor | TensorDictBase) → bool¶

如果值 val 可以由 TensorSpec 生成，則返回 True，否則返回 False。

See is_in() for more information.

cpu()¶: 將 TensorSpec 轉換為“cpu”裝置。

cuda(device=None)¶: 將 TensorSpec 轉換為“cuda”裝置。

property device: Union[device, str, int]¶

規格的裝置。

Only Composite specs can have a None device. All leaves must have a non-null device.

empty() → Composite[source]¶: 建立一個像 self 一樣的 spec，但沒有條目。

encode(val: np.ndarray | list | torch.Tensor | TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | TensorDictBase¶

使用指定的規格對值進行編碼，並返回相應的張量。

此方法用於返回易於對映到 TorchRL 所需域的值（例如 numpy 陣列）的環境。如果值已經是張量，則規格不會更改其值，而是按原樣返回。

引數:: val (np.ndarray 或 torch.Tensor) – 要編碼為張量的值。
關鍵字引數:: ignore_device (bool, 可選) – 如果為 True，則將忽略規格裝置。這用於在呼叫 TensorDict(..., device="cuda") 時將張量轉換分組，這樣更快速。
返回:: 符合所需張量規格的 torch.Tensor。

enumerate(use_mask: bool = False) → TensorDictBase[source]¶

返回可以從 TensorSpec 獲得的所有樣本。

樣本將沿第一個維度堆疊。

此方法僅為離散規格實現。

引數:: use_mask (bool, 可選) – 如果為 True 且規格有掩碼，則排除被掩碼的樣本。預設為 False。

erase_memoize_cache() → None[source]¶: 清除用於快取 encode 執行的快取。

另請參閱

memoize_encode().

expand(*shape: tuple[int, ...] | torch.Size) → Composite[source]¶

返回一個具有擴充套件形狀的新 Spec。

引數:: *shape (tuple 或 iterable of int) – Spec 的新形狀。必須可廣播到當前形狀：其長度至少等於當前形狀的長度，並且其最後的值也必須相容；即，只有噹噹前維度是單例時，它們才能與當前維度不同。

flatten(start_dim: int, end_dim: int) → T¶

展平一個 TensorSpec。

有關此方法的更多資訊，請檢視 flatten()。

get(item, default=_NoDefault.ZERO)[source]¶

從 Composite 中獲取一個條目。

如果條目不存在，可以傳入一個預設值。

classmethod implements_for_spec(torch_function: Callable) → Callable¶: 為 TensorSpec 註冊一個 torch 函式覆蓋。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase[source]¶

索引輸入張量。

此方法用於索引那些編碼一個或多個分類變數的規格（例如，OneHot 或 Categorical），以便在不關心索引的實際表示的情況下對張量進行索引。

引數:

index (int, torch.Tensor, slice 或 list) – 張量的索引
tensor_to_index – 要索引的張量

返回:

被索引的張量

示例

>>> from torchrl.data import OneHot
>>> import torch
>>>
>>> one_hot = OneHot(n=100)
>>> categ = one_hot.to_categorical_spec()
>>> idx_one_hot = torch.zeros((100,), dtype=torch.bool)
>>> idx_one_hot[50] = 1
>>> print(one_hot.index(idx_one_hot, torch.arange(100)))
tensor(50)
>>> idx_categ = one_hot.to_categorical(idx_one_hot)
>>> print(categ.index(idx_categ, torch.arange(100)))
tensor(50)

is_empty(recurse: bool = False)[source]¶

Composite spec 是否包含 spec。

引數:: recurse (bool) – 是否遞迴評估 spec 是否為空。如果為 True，則在沒有葉子節點的情況下返回 True。如果為 False (預設)，則返回根級別是否存在任何定義的 spec。

is_in(val: dict | TensorDictBase) → bool[source]¶

如果值 val 可以由 TensorSpec 生成，則返回 True，否則返回 False。

更具體地說，is_in 方法檢查值 val 是否在 space 屬性（盒子）定義的限制內，並且 dtype、device、shape 以及其他可能的元資料是否與規格匹配。如果任何檢查失敗，is_in 方法將返回 False。

引數:: val (torch.Tensor) – 要檢查的值。
返回:: 布林值，指示值是否屬於 TensorSpec 區域。

items(include_nested: bool = False, leaves_only: bool = False, *, is_leaf: Callable[[type], bool] | None = None, step_mdp_static_only: bool = False) → _CompositeSpecItemsView[source]¶

Composite 的條目。

引數:

include_nested (bool, optional) – 如果為 False，則返回的鍵將不會是巢狀的。它們將僅代表根的直接子項，而不是整個巢狀序列，即 Composite(next=Composite(obs=None)) 將導致鍵為 ["next"]. 預設為 ``False`，即不返回巢狀鍵。
leaves_only (bool, optional) – 如果為 False，則返回的值將包含每個巢狀級別，即 Composite(next=Composite(obs=None)) 將導致鍵為 ["next", ("next", "obs")]。預設值為 False。

關鍵字引數:

is_leaf (callable, optional) – 讀取一個型別並返回一個布林值，指示該型別是否應被視為葉子。預設情況下，所有非 Composite 節點都被視為葉子。
step_mdp_static_only (bool, optional) – 如果為 True，則僅返回在 step_mdp 下為靜態的鍵。預設值為 False。

keys(include_nested: bool = False, leaves_only: bool = False, *, is_leaf: Callable[[type], bool] | None = None, step_mdp_static_only: bool = False) → _CompositeSpecKeysView[source]¶

Composite 的鍵。

keys 引數反映了 tensordict.TensorDict 的引數。

引數:

include_nested (bool, optional) – 如果為 False，則返回的鍵將不會是巢狀的。它們將僅代表根的直接子項，而不是整個巢狀序列，即 Composite(next=Composite(obs=None)) 將導致鍵為 ["next"]. 預設為 ``False`，即不返回巢狀鍵。
leaves_only (bool, optional) – 如果為 False，則返回的值將包含每個巢狀級別，即 Composite(next=Composite(obs=None)) 將導致鍵為 ["next", ("next", "obs")]。預設值為 False。

關鍵字引數:

is_leaf (callable, optional) – 讀取一個型別並返回一個布林值，指示該型別是否應被視為葉子。預設情況下，所有非 Composite 節點都被視為葉子。
step_mdp_static_only (bool, optional) – 如果為 True，則僅返回在 step_mdp 下為靜態的鍵。預設值為 False。

lock_(recurse: bool | None = None) → None[source]¶

鎖定 Composite 並防止修改其內容。

recurse 引數控制 lock 是否會傳播到子 spec。當前預設值為 False，但為了與 v0.8 中的 TensorDict API 一致，它將更改為 True。

示例

>>> shape = [3, 4, 5]
>>> spec = Composite(
...         a=Composite(
...         b=Composite(shape=shape[:3], device="cpu"), shape=shape[:2]
...     ),
...     shape=shape[:1],
... )
>>> spec["a"] = spec["a"].clone()
>>> recurse = False
>>> spec.lock_(recurse=recurse)
>>> try:
...     spec["a"] = spec["a"].clone()
... except RuntimeError:
...     print("failed!")
failed!
>>> try:
...     spec["a", "b"] = spec["a", "b"].clone()
...     print("succeeded!")
... except RuntimeError:
...     print("failed!")
succeeded!
>>> recurse = True
>>> spec.lock_(recurse=recurse)
>>> try:
...     spec["a", "b"] = spec["a", "b"].clone()
...     print("succeeded!")
... except RuntimeError:
...     print("failed!")
failed!

make_neg_dim(dim: int) → T¶: 將特定維度轉換為 -1。

memoize_encode(mode: bool = True) → None[source]¶

建立 encode 方法的快取可呼叫序列，以加快其執行速度。

這應該只在輸入型別、形狀等在給定規格的呼叫之間預期一致時使用。

引數:: mode (bool, optional) – 是否使用快取。預設為 True。

另請參閱

快取可以透過 erase_memoize_cache() 擦除。

property ndim¶

規格形狀的維數。

相當於 len(spec.shape)。

ndimension()[source]¶

規格形狀的維數。

相當於 len(spec.shape)。

one(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶

返回盒中的一個填充一的張量。

注意

儘管不能保證 1 屬於規格域，但當此條件被違反時，此方法不會引發異常。 one 的主要用例是生成空的（資料）緩衝區，而不是有意義的資料。

引數:: shape (torch.Size) – one-tensor 的形狀
返回:: 在 TensorSpec 區域中取樣的填充一的張量。

ones(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: Proxy to one().

pop(key: NestedKey, default: Any = _NoDefault.ZERO) → Any[source]¶

從 composite spec 中刪除並返回與指定鍵關聯的值。

此方法在 composite spec 中搜索指定鍵，將其刪除，然後返回其關聯的值。如果找不到鍵，則返回提供的預設值（如果指定），否則引發 KeyError。

引數:

key (NestedKey) – 要從 composite spec 中刪除的鍵。它可以是單個鍵或巢狀鍵。
default (Any, optional) – 如果在 composite spec 中找不到指定的鍵，則返回的值。如果未提供且找不到鍵，則會引發 KeyError。

返回:

從 composite spec 中刪除的與指定鍵關聯的值。

返回型別:

任何

丟擲:

KeyError – 如果在 composite spec 中找不到指定的鍵且未提供預設值。

project(val: TensorDictBase) → TensorDictBase[source]¶

如果輸入張量不在 TensorSpec 區域內，則根據定義的啟發式方法將其映射回該區域。

引數:: val (torch.Tensor) – 要對映到盒子的張量。
返回:: 屬於 TensorSpec 區域的 torch.Tensor。

rand(shape: Optional[Size] = None) → TensorDictBase[source]¶

返回規格定義的區域中的隨機張量。

取樣將在區域內均勻進行，除非區域無界，在這種情況下將繪製正態值。

引數:: shape (torch.Size) – 隨機張量的形狀
返回:: 在 TensorSpec 區域中取樣的隨機張量。

reshape(*shape) → T¶

重塑一個 TensorSpec。

有關此方法的更多資訊，請檢視 reshape()。

sample(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶

返回規格定義的區域中的隨機張量。

See rand() for details.

separates(*keys: NestedKey, default: Optional[Any] = None) → Composite[source]¶

透過將指定的鍵及其關聯值提取到新的複合規格中來拆分複合規格。

此方法將迭代提供的鍵，將它們從當前複合規格中刪除，然後將它們新增到新的複合規格中。如果找不到鍵，將使用指定的預設值。將返回新的複合規格。

引數:

*keys (NestedKey) – 要從複合規格中提取的一個或多個鍵。每個鍵可以是單個鍵，也可以是巢狀鍵。
default (Any, optional) – 如果在複合規格中找不到指定的鍵，則使用的值。預設為 None。

返回:

包含提取的鍵及其關聯值的新複合規格。

返回型別:

Composite

注意

如果找不到任何指定的鍵，則該方法返回 None。

set(name: str, spec: TensorSpec) → Composite[source]¶: 在 Composite 規格中設定一個規格。

squeeze(dim: int | None = None) → Composite[source]¶

返回一個新 Spec，其中所有大小為 1 的維度都已刪除。

當給定 dim 時，僅在該維度上執行擠壓操作。

引數:: dim (int 或 None) – 應用擠壓操作的維度

to(dest: torch.dtype | DEVICE_TYPING) → Composite[source]¶

將 TensorSpec 轉換為裝置或 dtype。

如果未進行更改，則返回相同的規格。

to_numpy(val: TensorDict, safe: bool | None = None) → dict[source]¶

返回輸入張量的 np.ndarray 對應項。

This is intended to be the inverse operation of encode().

引數:

val (torch.Tensor) – 要轉換為 numpy 的張量。
safe (bool) – 布林值，指示是否應檢查值與規格域的匹配程度。預設為 CHECK_SPEC_ENCODE 環境變數的值。

返回:

一個 np.ndarray。

type_check(value: torch.Tensor | TensorDictBase, selected_keys: str | Sequence[str] | None = None)[source]¶

檢查輸入值 dtype 是否與 TensorSpec 的 dtype 匹配，如果不匹配則引發異常。

引數:

value (torch.Tensor) – 需要檢查 dtype 的張量。
key (str, optional) – 如果 TensorSpec 具有鍵，則將檢查值 dtype 是否與指定鍵指向的規格匹配。

unflatten(dim: int, sizes: tuple[int]) → T¶

解展一個 TensorSpec。

有關此方法的更多資訊，請檢視 unflatten()。

unlock_(recurse: bool | None = None) → T[source]¶

解鎖 Composite 並允許修改其內容。

除非透過 recurse 引數另有指定，否則這僅是第一級的鎖修改。

unsqueeze(dim: int) → Composite[source]¶

返回一個新 Spec，其中在 dim 指定的位置增加了一個單例維度。

引數:: dim (int 或 None) – 應用 unsqueeze 操作的維度。

values(include_nested: bool = False, leaves_only: bool = False, *, is_leaf: Callable[[type], bool] | None = None, step_mdp_static_only: bool = False) → _CompositeSpecValuesView[source]¶

Composite 的值。

引數:

include_nested (bool, optional) – 如果為 False，則返回的鍵將不會是巢狀的。它們將僅代表根的直接子項，而不是整個巢狀序列，即 Composite(next=Composite(obs=None)) 將導致鍵為 ["next"]. 預設為 ``False`，即不返回巢狀鍵。
leaves_only (bool, optional) – 如果為 False，則返回的值將包含每個巢狀級別，即 Composite(next=Composite(obs=None)) 將導致鍵為 ["next", ("next", "obs")]。預設值為 False。

關鍵字引數:

is_leaf (callable, optional) – 讀取一個型別並返回一個布林值，指示該型別是否應被視為葉子。預設情況下，所有非 Composite 節點都被視為葉子。
step_mdp_static_only (bool, optional) – 如果為 True，則僅返回在 step_mdp 下為靜態的鍵。預設值為 False。

view(*shape) → T¶

重塑一個 TensorSpec。

有關此方法的更多資訊，請檢視 reshape()。

zero(shape: Optional[Size] = None) → TensorDictBase[source]¶

返回盒中的零填充張量。

注意

儘管不能保證 0 屬於規格域，但當此條件被違反時，此方法不會引發異常。 zero 的主要用例是生成空的（資料）緩衝區，而不是有意義的資料。

引數:: shape (torch.Size) – zero-tensor 的形狀
返回:: 在 TensorSpec 框中取樣的零填充張量。

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: Proxy to zero().

Composite¶

文件

教程

資源