CompositeSpec¶

類 torchrl.data.CompositeSpec(*args, **kwargs)[源]¶

torchrl.data.Composite 的已棄用版本。

assert_is_in(value: Tensor) → None¶

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

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

cardinality() → int¶

該規約的基數。

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

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

clone() → Composite¶

克隆 Composite 規約。

被鎖定的規約不會產生被鎖定的克隆。

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

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

有關更多資訊，請參閱 is_in()。

cpu()¶: 將 TensorSpec 轉換為 ‘cpu’ 裝置。

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

屬性 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 or torch.Tensor) – 要編碼為張量的值。
關鍵字引數:: ignore_device (bool, optional) – 如果為 True，將忽略規約的裝置。這用於在呼叫 TensorDict(..., device="cuda") 中將張量轉換組合在一起，這樣更快。
返回:: 符合所需張量規約的 torch.Tensor。

enumerate() → TensorDictBase¶

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

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

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

expand(*shape)¶

返回具有擴充套件後形狀的新規約。

引數:: *shape (tuple or iterable of int) – 規約的新形狀。必須能與當前形狀廣播：其長度必須至少與當前形狀長度相等，其最後一個值也必須一致；即只有噹噹前維度是單例時，它們才可以不同。

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

展平一個 TensorSpec。

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

get(item, default=_NoDefault.ZERO)¶

從 Composite 中獲取一個條目。

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

類方法 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 = False)¶

複合規約是否包含規約。

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

is_in(val: Union[dict, TensorDictBase]) → 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, 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 節點都被視為葉節點。

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

Composite 的鍵。

鍵引數反映了 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 節點都被視為葉節點。

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) → T¶: 將指定維度轉換為 -1。

屬性 ndim¶

規約形狀的維度數量。

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

ndimension()¶

規約形狀的維度數量。

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

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

返回範圍內一個填充 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 (Any, optional) – 如果在複合規約中未找到指定鍵，則返回的值。如果未提供此引數且未找到鍵，則引發 KeyError 異常。

返回:

從複合規約中移除的、與指定鍵關聯的值。

返回型別:

Any

引發:

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 (Any, optional) – 如果在組合規範中未找到指定的鍵，則使用該值。預設為 None。

返回:

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

返回型別:

Composite

注意

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

set(name: str, spec: TensorSpec) → Composite¶: 在組合規範中設定一個規範。

squeeze(dim: int | None = None)¶

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

如果給定了 dim，則僅在該維度上執行壓縮操作。

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

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

將 TensorSpec 轉換到裝置或資料型別。

如果未做任何更改，則返回相同的規範。

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[str, Sequence[str]]] = None)¶

檢查輸入值 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¶

解鎖組合規範並允許修改其內容。

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

unsqueeze(dim: int)¶

返回一個新的規範，該規範在（由 dim 指示的位置）增加一個大小為 1 的維度。

引數:: dim (int or None) – 應用擴充套件操作的維度。

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

組合規範的值。

引數:

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 節點都被視為葉節點。

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() 的代理。

CompositeSpec¶

文件

教程

資源