MultiOneHot

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

一個獨熱離散張量規範的串聯。

當單個張量必須攜帶關於多個獨熱編碼值的資訊時，可以使用此類。

形狀的最後一個維度（張量元素的域）不能被索引。

引數:

• 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

斷言張量是否屬於該框（box），否則引發異常。

引數:

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

cardinality() → int

規範的基數（cardinality）。

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

clear_device_() → T

對於所有葉規範（必須有裝置），這是一個無操作（no-op）。

對於 Composite 規範，此方法將擦除裝置。

clone() → MultiOneHot

建立 TensorSpec 的副本。

contains(item: torch.Tensor | 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

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

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

引數:

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

關鍵字引數:

ignore_device (bool, 可選) – 如果為 True，則將忽略規範的裝置。這用於將張量轉換集中在呼叫 TensorDict(..., device="cuda") 中，這樣速度更快。

返回值:

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

enumerate() → Tensor

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

樣本將沿第一個維度堆疊。

此方法僅針對離散規範實現。

expand(*shape)

返回具有擴充套件形狀的新規範。

引數:

*shape (tuple 或 int 可迭代物件) – 規範的新形狀。必須與當前形狀可廣播：其長度必須至少等於當前形狀的長度，並且其最後的值也必須相容；即，只有當前維度是單例時，它們才能與當前形狀不同。

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

對輸入張量進行索引。

此方法用於編碼一個或多個分類變數（例如，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 以及其他可能的元資料與規範的匹配。如果其中任何檢查失敗，is_in 方法將返回 False。

引數:

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

返回值:

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

make_neg_dim(dim: int) → T

將特定維度轉換為 -1。

property ndim: int

規範形狀的維度數。

len(spec.shape) 的快捷方式。

ndimension() → int

規範形狀的維度數。

len(spec.shape) 的快捷方式。

one(shape: torch.Size = None) → torch.Tensor | TensorDictBase

返回框中填充了 1 的張量。

注意

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

引數:

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

返回值:

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

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

在規範定義的空間中返回一個隨機張量。

取樣將均勻地在空間上進行，除非框是無界的，在這種情況下將繪製正態分佈的值。

引數:

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

返回值:

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

reshape(*shape) → T

重塑一個 TensorSpec。

有關此方法的詳細資訊，請檢視 reshape()。

sample(shape: torch.Size = None) → torch.Tensor | TensorDictBase

在規範定義的空間中返回一個隨機張量。

詳情請參閱 rand()。

squeeze(dim=None)

返回一個新的規範（Spec），該規範移除了所有大小為 1 的維度。

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

引數:

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

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

將 TensorSpec 轉換為指定的裝置或資料型別。

如果未做任何更改，則返回相同的規範。

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

將給定的獨熱張量轉換為分類格式。

引數:

• val (torch.Tensor, optional) – 要轉換為分類格式的獨熱張量。

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

返回值:

分類張量。

示例

>>> 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

將規範轉換為等效的分類規範。

示例

>>> 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

檢查輸入值 dtype 是否與 TensorSpec 的 dtype 匹配，如果不匹配則引發異常。

引數:

• value (torch.Tensor) – 需要檢查資料型別的張量。

• key (str, optional) – 如果 TensorSpec 包含鍵，則將根據指定鍵指向的規範檢查值的資料型別。

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

取消展平（Unflattens）一個 TensorSpec。

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

unsqueeze(dim: int)

返回一個新的規範（Spec），並在 dim 指定的位置增加一個單例維度。

引數:

dim (int 或 None) – 應用擴充套件（unsqueeze）操作的維度。

update_mask(mask)

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

也可以在初始化規範時設定掩碼。

引數:

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

返回一個在盒內填充零的張量。

注意

儘管不能保證 0 屬於規範的域，但當違反此條件時，此方法不會引發異常。zero 的主要用例是生成空資料緩衝區，而不是有意義的資料。

引數:

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

返回值:

一個在 TensorSpec 盒內取樣的零填充張量。

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase

zero() 的代理。