MultiOneHotDiscreteTensorSpec

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

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

assert_is_in(value: Tensor) → None

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

參數:

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

clear_device_() → T

所有葉節點規格（必須有裝置）的無運算。

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

clone() → MultiOneHot

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

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

此方法用於環境回傳一個值（例如，一個 numpy array），且該值可以輕易地對應到 TorchRL 需要的 domain 時。如果該值已經是一個 tensor，spec 將不會變更其值並直接回傳。

參數:

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

關鍵字參數：

ignore_device (bool, optional) – 如果 True，spec 裝置將被忽略。 這用於將 tensor casting 分組在一個呼叫 TensorDict(..., device="cuda") 中，這樣會比較快。

回傳：

符合所需 tensor specs 的 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 函數覆寫。

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

索引輸入 tensor。

參數:

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

• tensor_to_index – 要被索引的 tensor

回傳：

已索引的 tensor

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

傳回邊界框中填充 1 的張量。

注意

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

參數:

shape (torch.Size) – 填充 1 的張量的形狀

回傳：

在 TensorSpec 邊界框中取樣的填充 1 的張量。

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

代理到 one()。

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

傳回由 spec 定義的空間中的隨機張量。

詳見 rand()。

squeeze(dim=None)

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

如果指定了 dim，則只在該維度上進行 squeeze 操作。

參數:

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

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

將 TensorSpec 轉換為 device 或 dtype。

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

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

將給定的 one-hot 張量轉換為 categorical 格式。

參數:

• val (torch.Tensor, optional) – 要轉換為 categorical 格式的 One-hot 張量。

• safe (bool) – 一個布林值，指示是否應根據 spec 的域對該值執行檢查。 預設為 CHECK_SPEC_ENCODE 環境變數的值。

回傳：

categorical 張量。

範例

>>> mone_hot = MultiOneHot((2, 3, 4))
>>> onehot_sample = mone_hot.rand()
>>> onehot_sample
tensor([False,  True, False, False,  True, False,  True, False, False])
>>> categ_sample = mone_hot.to_categorical(onehot_sample)
>>> categ_sample
tensor([1, 2, 1])

to_categorical_spec() → MultiCategorical

將 spec 轉換為等效的 categorical spec。

範例

>>> mone_hot = MultiOneHot((2, 3, 4))
>>> categ = mone_hot.to_categorical_spec()
>>> categ
MultiCategorical(
    shape=torch.Size([3]),
    space=BoxList(boxes=[CategoricalBox(n=2), CategoricalBox(n=3), CategoricalBox(n=4)]),
    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

MultiOneHot 的 No-op。

to_one_hot_spec() → OneHot

MultiOneHot 的 No-op。

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

檢查輸入值 dtype 是否與 TensorSpec 的 dtype 相符，如果不符則引發例外。

參數:

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

• key (str, optional) – 如果 TensorSpec 具有鍵，則會根據指定鍵所指向的規格檢查值的 dtype。

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

將 TensorSpec 扁平化。

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

unsqueeze(dim: int)

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

參數:

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

update_mask(mask)

設定遮罩以防止在取樣時發生某些可能的結果。

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

參數:

mask (torch.Tensor or None) – 布林遮罩。如果為 None，則停用遮罩。 否則，遮罩的形狀必須可擴展到規格的形狀。 False 會遮罩一個結果，而 True 會保留結果不遮罩。 如果所有可能的結果都被遮罩，則在取樣時會引發錯誤。

範例

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

view(*shape) → T

重新塑造 TensorSpec。

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

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

傳回框中填滿零的張量。

注意

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

參數:

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

回傳：

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

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

Proxy to zero().