MultiOneHot

class torchrl.data.MultiOneHot(nvec: Sequence[int], shape: Optional[Size] = None, device=None, dtype=torch.bool, use_register=False, mask: Optional[Tensor] = None)

一個 one-hot 離散張量規格的串聯。

當單一張量必須攜帶關於多個 one-hot 編碼值的資訊時，可以使用此類別。

shape 的最後一個維度（張量元素的域）無法編製索引。

參數:

• nvec (整數的可迭代物件) – 張量每個元素的基數。

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

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

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

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

範例

>>> ts = MultiOneHot((3,2,3))
>>> ts.rand()
tensor([ True, False, False,  True, False, False, False,  True])
>>> ts.is_in(torch.tensor([
...     0, 0, 1,
...     0, 1,
...     1, 0, 0], dtype=torch.bool))
True
>>> ts.is_in(torch.tensor([
...     1, 0, 1,
...     0, 1,
...     1, 0, 0], dtype=torch.bool))
False

assert_is_in(value: Tensor) → None

斷言 tensor 是否屬於 box，否則引發例外。

參數:

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

clear_device_() → T

所有 leaf specs 的 no-op（必須具有 device）。

對於 Composite specs，此方法將清除 device。

clone() → MultiOneHot

建立 TensorSpec 的副本。

contains(item: torch.Tensor | tensordict.base.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: Union[ndarray, Tensor], *, ignore_device: bool = False) → Tensor

根據指定的 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 或 iterable of int) – Spec 的新形狀。必須與當前形狀可廣播：它的長度必須至少與當前形狀長度一樣長，並且它的最後一個值也必須符合：即，只有在當前維度是單例時，它們才能與它不同。

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

展平一個 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

為 TensorSpec 註冊一個 torch function 覆寫。

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 屬性（box）定義的限制內，並且 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

代理至 one()。

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

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

參數:

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

傳回：

屬於 TensorSpec box 的 torch.Tensor。

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

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

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

參數:

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

傳回：

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

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) – 布林值，指示是否應對照規格的域對值執行檢查。預設為 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

將規格轉換為等效的 categorical 規格。

範例

>>> 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) – 布林值，指示是否應對照規格的域對值執行檢查。預設為 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

根據 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，其中包含一個以上的 singleton 維度（位於 dim 指示的位置）。

參數:

dim (int 或 None) – 將 unsqueeze 操作應用於的維度。

update_mask(mask)

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

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

參數:

mask (torch.Tensor 或 None) – 布林遮罩。如果為 None，則停用遮罩。否則，遮罩的形狀必須可擴展至 spec 的形狀。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

傳回在 box 中填充零的張量。

注意

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

參數:

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

傳回：

在 TensorSpec box 中取樣的填充零的張量。

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

Proxy to zero().