OneHotDiscreteTensorSpec

類 torchrl.data.OneHotDiscreteTensorSpec(*args, **kwargs)

已棄用的版本：torchrl.data.OneHot。

assert_is_in(value: Tensor) → None

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

引數：

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

cardinality() → int

Spec 的基數。

這指的是 Spec 中可能結果的數量。假設組合 Spec 的基數是所有可能結果的笛卡爾積。

clear_device_() → T

對所有葉子 Spec（必須有裝置）而言是空操作 (no-op)。

對於 Composite Spec，此方法將擦除裝置資訊。

clone() → OneHot

建立一個 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: Union[ndarray, Tensor], space: Optional[CategoricalBox] = None, *, ignore_device: bool = False) → Tensor

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

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

引數：

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

關鍵字引數：

ignore_device (bool, optional) – 如果為 True，則忽略 spec 裝置。這用於在呼叫 TensorDict(..., device="cuda") 時進行張量型別轉換分組，這樣更快。

返回：

匹配所需張量 specs 的 torch.Tensor。

enumerate() → Tensor

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

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

此方法僅針對離散型 Spec 實現。

expand(*shape)

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

引數：

*shape (tuple 或 int 可迭代物件) – Spec 的新形狀。必須與當前形狀可廣播：其長度必須至少與當前形狀長度相同，並且其最後一個值也必須相容；也就是說，它們只能在當前維度為單例時與當前形狀不同。

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

展平一個 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

為 TensorSpec 註冊一個 torch 函式重寫。

index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: Tensor) → Tensor

對輸入張量進行索引。

此方法用於編碼一個或多個分類變數（例如 OneHot 或 Categorical）的 specs，以便在對張量進行樣本索引時，無需關注索引的實際表示形式。

引數：

• 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 屬性（範圍）定義的限制內，並且 dtype、device、shape 以及潛在的其他元資料是否與 spec 的匹配。如果其中任何檢查失敗，is_in 方法將返回 False。

引數：

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

返回：

布林值，指示值是否屬於 TensorSpec 的範圍。

make_neg_dim(dim: int) → T

將特定維度轉換為 -1。

property ndim: int

Spec 形狀的維度數。

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

ndimension() → int

Spec 形狀的維度數。

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

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

返回範圍內填充為 1 的張量。

注意

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

引數：

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

返回：

在 TensorSpec 範圍內取樣得到的全一張量。

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

one() 的代理方法。

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

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

引數：

val (torch.Tensor) – 要對映到範圍內的張量。

返回：

屬於 TensorSpec 範圍的 torch.Tensor。

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

返回 spec 定義空間內的隨機張量。

取樣將在空間內均勻進行，除非範圍無界，此時將抽取正態分佈值。

引數：

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

返回：

在 TensorSpec 範圍內取樣的隨機張量。

reshape(*shape) → T

重塑一個 TensorSpec。

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

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

返回 spec 定義空間內的隨機張量。

詳情請參見 rand()。

squeeze(dim=None)

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

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

引數：

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

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

將 TensorSpec 轉換為裝置或 dtype。

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

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

將給定的獨熱 (one-hot) 張量轉換為分類格式。

引數：

• val (torch.Tensor, optional) – 要轉換為分類格式的獨熱張量。

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

返回：

分類張量。

示例

>>> one_hot = OneHot(3, shape=(2, 3))
>>> one_hot_sample = one_hot.rand()
>>> one_hot_sample
tensor([[False,  True, False],
        [False,  True, False]])
>>> categ_sample = one_hot.to_categorical(one_hot_sample)
>>> categ_sample
tensor([1, 1])

to_categorical_spec() → Categorical

將 spec 轉換為等效的分類 spec。

示例

>>> one_hot = OneHot(3, shape=(2, 3))
>>> one_hot.to_categorical_spec()
Categorical(
    shape=torch.Size([2]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.int64,
    domain=discrete)

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

返回輸入張量對應的 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

對於 OneHot 而言是空操作 (No-op)。

to_one_hot_spec() → OneHot

對於 OneHot 而言是空操作 (No-op)。

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

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

引數：

• value (torch.Tensor) – 需要檢查資料型別的張量。

• key (str, optional) – 如果 TensorSpec 包含鍵，則將根據指定鍵指向的規範來檢查值的資料型別。

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

解除展平一個 TensorSpec。

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

unsqueeze(dim: int)

返回一個帶有額外一個單例維度（位於 dim 指定的位置）的新 Spec。

引數：

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

update_mask(mask)

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

掩碼也可以在初始化規範時設定。

引數：

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

示例

>>> mask = torch.tensor([True, False, False])
>>> ts = OneHot(3, (2, 3,), dtype=torch.int64, mask=mask)
>>> # All but one of the three possible outcomes are masked
>>> ts.rand()
tensor([[1, 0, 0],
        [1, 0, 0]])

view(*shape) → T

重塑一個 TensorSpec。

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

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

返回規範範圍內的零值填充張量。

注意

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

引數：

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

返回：

一個在 TensorSpec 規範範圍內取樣的零值填充張量。

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

zero() 的代理。