MultiDiscreteTensorSpec

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

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

assert_is_in(value: Tensor) → None

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

參數:

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

clear_device_() → T

所有葉節點 spec 的無運算 (no-op) (必須具有裝置)。

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

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 編碼一個值，並返回相應的 tensor。

此方法用於環境返回一個值 (例如，一個 numpy 陣列)，該值可以輕鬆對應到 TorchRL 所需的域。如果該值已經是一個 tensor，則 spec 不會改變其值，並將其原樣返回。

參數:

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

關鍵字參數:

ignore_device (bool, optional) – 如果 True，則 spec device 將被忽略。這用於在呼叫 TensorDict(..., device="cuda") 中進行 tensor 轉換，這樣更快。

返回:

符合所需 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 function override。

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

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

返回 box 中填滿 1 的 tensor。

注意

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

參數:

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

返回:

在 TensorSpec box 中採樣的一個填滿 1 的 tensor。

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

Proxy to one()。

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

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

參數:

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

返回:

屬於 TensorSpec box 的 torch.Tensor。

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

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

採樣將在空間上均勻完成，除非 box 是無界的，在這種情況下，將繪製正態值。

參數:

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

返回:

在 TensorSpec box 中採樣的隨機 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) – 要將 squeeze 運算應用於的維度

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]

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

參數:

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

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

返回:

one-hot 編碼後的張量。

to_one_hot_spec() → MultiOneHot

將規格轉換為等效的 one-hot 規格。

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

根據 TensorSpec dtype 檢查輸入值 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，則停用遮罩。否則，遮罩的形狀必須可擴展到等效 one-hot 規格的形狀。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 屬於規格網域，但在此條件未滿足時，此方法也不會引發例外。zero 的主要用例是產生空的資料緩衝區，而不是有意義的資料。

參數:

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

返回:

在 TensorSpec 方塊中採樣的填滿零的張量。

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

代理至 zero()。