MultiDiscreteTensorSpec

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

已棄用版本，替代為 torchrl.data.MultiCategorical。

assert_is_in(value: Tensor) → None

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

引數：

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

cardinality() → int

spec 的基數。

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

clear_device_() → T

對於所有葉子 spec（必須有 device），這是一個空操作。

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

clone() → MultiCategorical

建立 TensorSpec 的副本。

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

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

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

cpu()

將 TensorSpec 轉換為 'cpu' device。

cuda(device=None)

將 TensorSpec 轉換為 'cuda' device。

device: torch.device | None = None

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

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

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

引數：

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

關鍵詞引數：

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

返回：

與所需張量 spec 匹配的 torch.Tensor。

enumerate() → Tensor

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

樣本將沿第一維堆疊。

此方法僅為離散 spec 實現。

expand(*shape)

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

引數：

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

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

引數：

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

返回：

布林值，指示值是否屬於 TensorSpec 框。

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

返回框中的全一張量。

注意

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

引數：

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

返回：

在 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) – 隨機張量的 shape

返回：

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

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: int | None = None)

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

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

引數：

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

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

將 TensorSpec 轉換為 device 或 dtype。

如果沒有發生變化，則返回相同的 spec。

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

MultiCategorical 的非操作。

to_categorical_spec() → MultiCategorical

MultiCategorical 的非操作。

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) → Union[MultiOneHot, Tensor]

將 spec 域中的離散張量編碼為其對應的 one-hot 形式。

引數：

• val (torch.Tensor, 可選) – 要進行 one-hot 編碼的張量。

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

返回：

one-hot 編碼後的張量。

to_one_hot_spec() → MultiOneHot

將 spec 轉換為等效的 one-hot spec。

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

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

引數：

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

• key (str, optional) – 如果 TensorSpec 包含鍵，則會根據指定鍵指向的 spec 檢查值的 dtype。

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

取消扁平化一個 TensorSpec。

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

unsqueeze(dim: int)

返回一個新的 Spec，其中包含一個額外的單例維度 (位於 dim 指定的位置)。

引數：

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

update_mask(mask)

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

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

引數：

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

示例

>>> torch.manual_seed(0)
>>> mask = torch.tensor([False, False, True,
...                      True, True])
>>> ts = MultiCategorical((3, 2), (5, 2,), dtype=torch.int64, mask=mask)
>>> # All but one of the three possible outcomes for the first
>>> # group are masked, but neither of the two possible
>>> # outcomes for the second group are masked.
>>> ts.rand()
tensor([[2, 1],
        [2, 0],
        [2, 1],
        [2, 1],
        [2, 1]])

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