MultiCategorical

class torchrl.data.MultiCategorical(nvec: Union[Sequence[int], Tensor, int], shape: Optional[Size] = None, device: Optional[Union[device, str, int]] = None, dtype: Optional[Union[str, dtype]] = torch.int64, mask: Optional[Tensor] = None, remove_singleton: bool = True)

離散張量規格 (discrete tensor spec) 的串聯。

參數：

• nvec (整數的可迭代物件 或 torch.Tensor) – 張量每個元素的基數。可以有多個軸。

• shape (torch.Size, 可選) – 採樣張量的總形狀。 如果提供，則最後 m 個維度必須符合 nvec.shape。

• device (str, int 或 torch.device, 可選) – 張量的裝置。

• dtype (str 或 torch.dtype, 可選) – 張量的資料類型。

• remove_singleton (bool, 可選) – 如果 True，則會擠壓 (squeeze) 大小為 [1] 的單例樣本 (singleton samples)。預設為 True。

• mask (torch.Tensor 或 None) – 在進行取樣時，遮罩一些可能的結果。 有關更多資訊，請參閱 update_mask()。

範例

>>> ts = MultiCategorical((3, 2, 3))
>>> ts.is_in(torch.tensor([2, 0, 1]))
True
>>> ts.is_in(torch.tensor([2, 10, 1]))
False

assert_is_in(value: Tensor) → None

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

參數：

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

clear_device_() → T

所有葉規格 (leaf specs) 的無操作 (no-op) (必須具有裝置)。

對於 Composite 規格，此方法將清除裝置。

clone() → MultiCategorical

建立 TensorSpec 的副本。

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

如果值 val 可能由 TensorSpec 產生，則傳回 True，否則傳回 False。

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

cpu()

將 TensorSpec 轉換為 'cpu' 裝置。

cuda(device=None)

將 TensorSpec 轉換到 'cuda' 裝置。

device: torch.device | None = None

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

根據指定的 spec 編碼一個值，並傳回對應的張量。

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

參數：

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

關鍵字參數：

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

回傳：

符合所需張量規格的 torch.Tensor。

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 函數覆寫。

abstract index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: torch.Tensor | tensordict.base.TensorDictBase) → torch.Tensor | tensordict.base.TensorDictBase

為輸入張量建立索引。

參數：

• index (int, torch.Tensor, slice 或 list) – 張量的索引

• tensor_to_index – 要建立索引的張量

回傳：

已建立索引的張量

is_in(val: Tensor) → bool

如果值 val 可能由 TensorSpec 產生，則傳回 True，否則傳回 False。

更精確地說，is_in 方法會檢查數值 val 是否在 space 屬性（即盒子）定義的範圍內，並且 dtype、device、shape 以及潛在的其他 metadata 是否與 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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

返回一個在盒子中填滿 1 的 tensor。

注意

即使無法保證 1 屬於 spec 的 domain，當違反此條件時，此方法也不會引發例外。 one 的主要用例是生成空的數據緩衝區，而不是有意義的數據。

參數：

shape (torch.Size) – one-tensor 的形狀

回傳：

一個在 TensorSpec 盒子中採樣，填滿 1 的 tensor。

ones(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

是 one() 的代理。

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

如果輸入的 tensor 不在 TensorSpec 盒子中，它會根據一些定義的啟發式方法將其映射回盒子中。

參數：

val (torch.Tensor) – 要映射到盒子的 tensor。

回傳：

屬於 TensorSpec 盒子的一個 torch.Tensor。

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

返回一個 spec 定義的空間中的隨機 tensor。

除非盒子是無界的，在這種情況下，將會抽取常態值，否則抽樣將在整個空間上均勻完成。

參數：

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

回傳：

一個在 TensorSpec 盒子中採樣的隨機 tensor。

reshape(*shape) → T

重塑 TensorSpec。

有關此方法的更多信息，請查看 reshape() 。

sample(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

返回一個 spec 定義的空間中的隨機 tensor。

詳情請參閱 rand()。

squeeze(dim: Optional[int] = None)

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

當提供 dim 時，擠壓 (squeeze) 操作僅在該維度上執行。

參數：

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，這是一個空操作 (no-op)。

to_categorical_spec() → MultiCategorical

對於 MultiCategorical，這是一個空操作 (no-op)。

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

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

此操作旨在成為 encode() 的反向操作。

參數：

• val (torch.Tensor) – 要轉換為 numpy 的張量。

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

回傳：

一個 np.ndarray。

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

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

參數：

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

• safe (bool) – 指示是否應針對 spec 的域 (domain) 對值執行檢查的布林值。預設為 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 檢查 value 的 dtype。

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

將 TensorSpec 扁平化。

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

unsqueeze(dim: int)

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

參數：

dim (int 或 None) – 套用 unsqueeze 運算的維度。

update_mask(mask)

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

遮罩也可以在 spec 初始化期間設定。

參數：

mask (torch.Tensor 或 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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

傳回方框中一個填滿零的張量。

注意

即使無法保證 0 屬於 spec 域，此方法也不會在違反此條件時引發例外。 zero 的主要用途是產生空的資料緩衝區，而不是有意義的資料。

參數：

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

回傳：

在 TensorSpec 方框中取樣的填滿零的張量。

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

代理到 zero()。