LazyStackedCompositeSpec

class torchrl.data.LazyStackedCompositeSpec(*args, **kwargs)

torchrl.data.StackedComposite 已廢棄的版本。

assert_is_in(value: Tensor) → None

斷言張量是否屬於該範圍，否則引發異常。

引數：

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

cardinality(*args, **kwargs) → Any

規範（spec）的基數。

這指的是一個規範中可能結果的數量。假定複合規範（composite spec）的基數是所有可能結果的笛卡爾積。

clear_device_()

清除 Composite 的裝置設定。

clone() → T

克隆 Composite 規範。

鎖定的規範不會產生鎖定的克隆。

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

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

請參閱 is_in() 瞭解更多資訊。

cpu()

將 TensorSpec 轉換到 ‘cpu’ 裝置。

cuda(device=None)

將 TensorSpec 轉換到 ‘cuda’ 裝置。

property device: Union[device, str, int]

規範的裝置。

只有 Composite 規範可以擁有 None 裝置。所有葉節點必須擁有非空裝置。

empty()

建立一個與自身類似但沒有條目的規範。

encode(vals: Dict[str, Any], ignore_device: bool = False) → Dict[str, Tensor]

根據指定的規範對值進行編碼，並返回相應的張量。

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

引數：

val (np.ndarray 或 torch.Tensor) – 要編碼為張量的值。

關鍵字引數：

ignore_device (bool, 可選) – 如果為 True，則忽略規範裝置。這用於將張量轉換分組到對 TensorDict(..., device="cuda") 的呼叫中，這樣更快。

返回值：

匹配所需張量規範的 torch.Tensor。

enumerate() → TensorDictBase

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

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

此方法僅針對離散規範實現。

expand(*shape)

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

引數：

*shape (tuple or iterable of int) – Spec 的新形狀。必須可與當前形狀廣播：其長度必須至少與當前形狀長度一樣長，並且其最後一個值也必須相容；即它們只能在當前維度是單例時才與當前形狀不同。

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

展平（flatten）一個 TensorSpec。

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

get(item, default=_NoDefault.ZERO)

從 Composite 中獲取一個專案。

如果專案不存在，可以傳遞一個預設值。

classmethod implements_for_spec(torch_function: Callable) → Callable

為 TensorSpec 註冊 torch 函式覆蓋。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase

對輸入張量進行索引。

此方法應與編碼一個或多個分類變數（例如 OneHot 或 Categorical）的規範一起使用，這樣就可以在不關心索引實際表示的情況下對張量進行索引操作。

引數：

• index (int, torch.Tensor, slice or 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 | None =None)

複合規範是否包含子規範。

引數：

recurse (bool) – 是否遞迴評估規範是否為空。如果為 True，則在沒有葉節點時返回 True。如果為 False（預設），則返回根級別是否定義了任何規範。

is_in(value) → bool

如果值 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) → _CompositeSpecItemsView

Composite 的專案。

引數：

• include_nested (bool, 可選) – 如果為 False，則返回的鍵不會巢狀。它們將僅表示根的直接子項，而不是整個巢狀序列，例如 Composite(next=Composite(obs=None)) 將導致鍵為 ["next"]. 預設值為 False，即不會返回巢狀鍵。

• leaves_only (bool, 可選) – 如果為 False，則返回的值將包含所有級別的巢狀，例如 Composite(next=Composite(obs=None)) 將導致鍵為 ["next", ("next", "obs")]。預設值為 False。

關鍵字引數：

is_leaf (callable, 可選) – 讀取一個型別並返回一個布林值，指示該型別是否應被視為葉節點。預設情況下，所有非 Composite 節點都被視為葉節點。

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

Composite 的鍵。

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

引數：

• include_nested (bool, 可選) – 如果為 False，則返回的鍵不會巢狀。它們將僅表示根的直接子項，而不是整個巢狀序列，例如 Composite(next=Composite(obs=None)) 將導致鍵為 ["next"]. 預設值為 False，即不會返回巢狀鍵。

• leaves_only (bool, 可選) – 如果為 False，則返回的值將包含所有級別的巢狀，例如 Composite(next=Composite(obs=None)) 將導致鍵為 ["next", ("next", "obs")]。預設值為 False。

關鍵字引數：

is_leaf (callable, 可選) – 讀取一個型別並返回一個布林值，指示該型別是否應被視為葉節點。預設情況下，所有非 Composite 節點都被視為葉節點。

lock_(recurse: bool | None =None) → T

鎖定 Composite 並阻止對其內容的修改。

recurse 引數控制鎖定是否傳播到子規範。當前預設值為 False，但在 v0.8 版本中將更改為 True，以與 TensorDict API 保持一致。

示例

>>> 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)

將特定維度轉換為 -1。

property ndim

規範形狀的維度數。

len(spec.shape) 的快捷方式。

ndimension()

規範形狀的維度數。

len(spec.shape) 的快捷方式。

one(shape: Optional[Size] = None) → TensorDictBase

返回該範圍（box）內的一個填充有 1 的張量。

注意

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

引數：

shape (torch.Size) – 填充有 1 的張量的形狀

返回值：

在 TensorSpec 範圍內取樣的填充有 1 的張量。

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

one() 的代理。

pop(key: NestedKey, default: Any =_NoDefault.ZERO) → Any

從複合規範中移除並返回與指定鍵關聯的值。

此方法在複合規範中搜索給定的鍵，將其移除，並返回其關聯的值。如果未找到該鍵，則在指定預設值的情況下返回預設值，否則引發 KeyError。

引數：

• key (NestedKey) – 要從複合規範中移除的鍵。可以是單個鍵或巢狀鍵。

• default (任意型別, 可選) – 如果在組合規格中找不到指定的鍵，則返回的值。如果未提供且找不到鍵，則會引發 KeyError。

返回值：

從組合規格中移除的與指定鍵關聯的值。

返回型別:

任意型別

引發:

KeyError – 如果在組合規格中找不到指定的鍵且未提供預設值。

project(val: TensorDictBase) → TensorDictBase

如果輸入張量不在 TensorSpec 框中，則根據一些已定義的啟發式方法將其映射回框中。

引數：

val (torch.Tensor) – 要對映到框中的張量。

返回值：

屬於 TensorSpec 框的 torch.Tensor。

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

返回由規格定義的空間中的隨機張量。

取樣將在空間中均勻進行，除非該框是無界的，在這種情況下將抽取正態值。

引數：

shape (torch.Size) – 隨機張量的形狀

返回值：

在 TensorSpec 框中取樣的隨機張量。

reshape(*shape) → T

重塑 TensorSpec。

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

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

返回由規格定義的空間中的隨機張量。

詳見 rand()。

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

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

此方法遍歷提供的鍵，將其從當前組合規格中移除，並將其新增到新的組合規格中。如果找不到鍵，則使用指定的預設值。返回新的組合規格。

引數：

• *keys (NestedKey) – 要從組合規格中提取的一個或多個鍵。每個鍵可以是單個鍵或巢狀鍵。

• default (任意型別, 可選) – 如果在組合規格中找不到指定的鍵，則使用的值。預設為 None。

返回值：

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

返回型別:

Composite

注意

如果所有指定的鍵都找不到，則方法返回 None。

set(name: str, spec: TensorSpec) → StackedComposite

在組合規格中設定一個規格。

squeeze(dim: Optional[int] = None)

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

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

引數：

dim (int 或 None) – 應用壓縮操作的維度

to(dest: Union[dtype, device, str, int]) → T

將 TensorSpec 轉換到裝置或 dtype。

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

to_numpy(val: TensorDict, safe: Optional[bool] = None) → dict

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

這旨在作為 encode() 的逆操作。

引數：

• val (torch.Tensor) – 要轉換為 numpy 的張量。

• safe (bool) – 布林值，指示是否應對值根據規格域進行檢查。預設為 CHECK_SPEC_ENCODE 環境變數的值。

返回值：

一個 np.ndarray。

type_check(value: Union[Tensor, TensorDictBase], selected_keys: Optional[Union[NestedKey, Sequence[NestedKey]]] = None)

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

引數：

• value (torch.Tensor) – 需要檢查 dtype 的張量。

• key (str, 可選) – 如果 TensorSpec 具有鍵，則值 dtype 將根據指示鍵指向的規格進行檢查。

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

展開 TensorSpec。

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

unlock_(recurse: bool | None = None) → T

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

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

unsqueeze(dim: int)

返回一個新的規格，其中多了一個單例維度（在由 dim 指示的位置）。

引數：

dim (int 或 None) – 應用非壓縮操作的維度。

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

Composite 的值。

引數：

• include_nested (bool, 可選) – 如果為 False，則返回的鍵不會巢狀。它們將僅表示根的直接子項，而不是整個巢狀序列，例如 Composite(next=Composite(obs=None)) 將導致鍵為 ["next"]. 預設值為 False，即不會返回巢狀鍵。

• leaves_only (bool, 可選) – 如果為 False，則返回的值將包含所有級別的巢狀，例如 Composite(next=Composite(obs=None)) 將導致鍵為 ["next", ("next", "obs")]。預設值為 False。

關鍵字引數：

is_leaf (callable, 可選) – 讀取一個型別並返回一個布林值，指示該型別是否應被視為葉節點。預設情況下，所有非 Composite 節點都被視為葉節點。

view(*shape) → T

重塑 TensorSpec。

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

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

返回框中填充零的張量。

注意

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

引數：

shape (torch.Size) – 零張量的形狀

返回值：

在 TensorSpec 框中取樣的填充零的張量。

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

zero() 的代理。