BinaryDiscreteTensorSpec¶

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

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

assert_is_in(value: Tensor) → None¶

斷言張量是否屬於指定的範圍（box），否則丟擲異常。

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

cardinality() → int¶

spec 的基數（cardinality）。

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

clear_device_() → T¶

對所有葉子 spec（必須有 device）的無操作（no-op）。

對於 Composite spec，此方法將擦除 device。

clone() → Binary¶: 建立 TensorSpec 的副本。

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

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

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

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

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

device: torch.device | None = None¶

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

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

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

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

enumerate() → Tensor¶

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

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

此方法僅針對離散 spec 實現。

expand(*shape)¶

返回具有展開形狀的新 Spec。

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

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

展平 TensorSpec。

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

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

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

對輸入張量進行索引。

此方法用於編碼一個或多個分類變數的 spec（例如，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_in(val: Tensor) → bool¶

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

更準確地說，is_in 方法檢查值 val 是否在 space 屬性（即 box）定義的範圍內，並且 dtype、device、shape 以及可能的其他元資料是否與 spec 的元資料匹配。如果這些檢查中有任何一個失敗，is_in 方法將返回 False。

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

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

property ndim: int¶

spec shape 的維度數量。

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

ndimension() → int¶

spec shape 的維度數量。

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

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

返回 box 中填充為 1 的張量。

注意

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

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

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

project(val: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase¶

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

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

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

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

取樣將均勻地在空間上進行，除非 box 是無界的，此時將繪製正態分佈值。

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

reshape(*shape) → T¶

重塑 TensorSpec。

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

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

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

有關詳細資訊，請參閱 rand()。

set_provisional_n(n: int)¶

臨時設定 Categorical spec 的基數。

當 n 為 -1 時，在從 spec 取樣之前必須呼叫此方法。

引數:: n (int) – Categorical spec 的基數。

squeeze(dim=None)¶

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

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

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

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

將 TensorSpec 轉換為裝置或 dtype。

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

to_categorical(val: Tensor, safe: Optional[bool] = None) → Tensor¶: 對於 categorical 的無操作（no-op）。

to_categorical_spec() → Categorical¶: 對於 categorical 的無操作（no-op）。

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

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

這被認為是 encode() 操作的逆向過程。

引數:

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

返回:

一個 np.ndarray。

to_one_hot(val: Tensor, safe: Optional[bool] = None) → Tensor¶

將 spec 域中的離散張量編碼為其對應的獨熱（one-hot）張量。

引數:

val (torch.Tensor, optional) – 要進行獨熱編碼的張量。
safe (bool) – 布林值，指示是否應該對照 spec 的域對值進行檢查。預設為 CHECK_SPEC_ENCODE 環境變數的值。

返回:

獨熱編碼後的張量。

示例

>>> categ = Categorical(3)
>>> categ_sample = categ.zero()
>>> categ_sample
tensor(0)
>>> onehot_sample = categ.to_one_hot(categ_sample)
>>> onehot_sample
tensor([ True, False, False])

to_one_hot_spec() → OneHot¶

將 spec 轉換為等效的獨熱 spec。

示例

>>> categ = Categorical(3)
>>> categ.to_one_hot_spec()
OneHot(
    shape=torch.Size([3]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

type_check(value: Tensor, key: Optional[NestedKey] = None) → None¶

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

引數:

value (torch.Tensor) – 需要檢查其 dtype 的張量。
key (str, optional) – 如果 TensorSpec 有鍵，則將根據指定鍵指向的 spec 檢查值的 dtype。

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

對 TensorSpec 進行 unflatten 操作。

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

unsqueeze(dim: int)¶

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

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

update_mask(mask)¶

設定一個掩碼，以在取樣時阻止某些可能的結果。

該掩碼也可以在 spec 初始化時設定。

引數:: mask (torch.Tensor or None) – 布林型掩碼。如果為 None，則停用掩碼。否則，掩碼的形狀必須可擴充套件到等效獨熱 spec 的形狀。False 遮蔽一個結果，True 使結果不被遮蔽。如果所有可能的結果都被遮蔽，則在取樣時會引發錯誤。

示例

>>> mask = torch.tensor([True, False, True])
>>> ts = Categorical(3, (10,), dtype=torch.int64, mask=mask)
>>> # One of the three possible outcomes is masked
>>> ts.rand()
tensor([0, 2, 2, 0, 2, 0, 2, 2, 0, 2])

view(*shape) → T¶

重塑 TensorSpec。

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

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

返回 Box 中一個填充了零的張量。

注意

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

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

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: zero() 的代理。

BinaryDiscreteTensorSpec¶

文件

教程

資源