StackedComposite¶

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

堆疊複合規範的惰性表示。

沿一個維度堆疊複合規範。當繪製隨機樣本時，返回一個 LazyStackedTensorDict。

允許索引，但僅沿堆疊維度進行。

此類旨在用於多工和多智慧體設定，在這些設定中可能會出現異構規範（語義相同但形狀不同）。

assert_is_in(value: Tensor) → None¶

斷言張量是否屬於框（box），否則引發異常。

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

cardinality(*args, **kwargs) → Any[source]¶

規範的基數。

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

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()[source]¶: 建立一個類似自身的規範，但不包含條目。

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

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

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

引數:: val (np.ndarray or torch.Tensor) – 要編碼為張量的值。
關鍵字引數:: ignore_device (bool, optional) – 如果為 True，則將忽略規範裝置。這用於在呼叫 TensorDict(..., device="cuda") 中對張量轉換進行分組，這會更快。
返回值:: 與所需張量規範匹配的 torch.Tensor。

enumerate() → TensorDictBase[source]¶

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

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

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

expand(*shape)[source]¶

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

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

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

展平 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[source]¶

對輸入張量進行索引。

此方法用於編碼一個或多個分類變數（例如 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 = False)¶

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

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

is_in(value) → 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) → _CompositeSpecItemsView[source]¶

Composite 的項。

引數:

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

關鍵字引數:

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

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

Composite 的鍵。

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

引數:

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

關鍵字引數:

is_leaf (callable, optional) – 讀取一個型別並返回一個布林值，指示該型別是否應被視為葉節點。預設情況下，所有非 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()[source]¶

規範形狀的維度數量。

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

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

返回框中填充一值的張量。

注意

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

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

ones(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: 是 one() 的代理。

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

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

此方法在 composite spec 中搜索給定的鍵，移除它，並返回其關聯的值。如果未找到該鍵，則返回指定的預設值（如果已指定），否則引發 KeyError。

引數:

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

返回值:

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

返回型別:

Any

丟擲異常:

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

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

如果輸入的張量不在 TensorSpec 的 'box' 內，它將根據一些啟發式規則將其映射回 'box'。

引數:: val (torch.Tensor) – 要對映到 'box' 的張量。
返回值:: 屬於 TensorSpec 的 'box' 的 torch.Tensor。

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

在由 spec 定義的空間中返回一個隨機張量。

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

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

reshape(*shape) → T¶

重塑一個 TensorSpec。

檢視 reshape() 以獲取更多資訊。

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

在由 spec 定義的空間中返回一個隨機張量。

詳情請參見 rand()。

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

透過提取指定的鍵及其關聯的值來分割 composite spec，並放入一個新的 composite spec 中。

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

引數:

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

返回值:

包含提取的鍵及其關聯值的新 composite spec。

返回型別:

Composite

注意

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

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

squeeze(dim: Optional[int] = None)¶

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

當指定了 dim 時，僅在該維度執行 squeeze 操作。

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

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

將 TensorSpec 轉換為裝置或 dtype。

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

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

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

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

引數:

val (torch.Tensor) – 要轉換為 numpy 的張量。
safe (bool, 可選) – 指示是否應對照 spec 的域檢查值。預設為 CHECK_SPEC_ENCODE 環境變數的值。

返回值:

一個 np.ndarray。

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

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

引數:

value (torch.Tensor) – 要檢查其 dtype 的張量。
key (str, 可選) – 如果 TensorSpec 包含鍵，則將對照指定鍵指向的 spec 檢查值的 dtype。

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

展開一個 TensorSpec。

檢視 unflatten() 以獲取更多資訊。

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

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

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

unsqueeze(dim: int)¶

返回一個新 Spec，其中增加了（由 dim 指示位置的）一個大小為 1 的維度。

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

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

Composite 的值。

引數:

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

關鍵字引數:

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

view(*shape) → T¶

重塑一個 TensorSpec。

檢視 reshape() 以獲取更多資訊。

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

注意

在 'box' 中返回一個填充了零的張量。

引數:: 即使不能保證 0 屬於 spec 域，當違反此條件時此方法也不會引發異常。`zero` 的主要用例是生成空的資料緩衝區，而不是有意義的資料。
返回值:: shape (torch.Size) – 零填充張量的形狀。

在 TensorSpec 的 'box' 中取樣的零填充張量。: zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶

StackedComposite¶

文件

檢視文件

檢視教程