MultiOneHotDiscreteTensorSpec¶

類 torchrl.data.MultiOneHotDiscreteTensorSpec(*args, **kwargs)[原始碼]¶

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

assert_is_in(value: Tensor) → None¶

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

引數：:: value (torch.Tensor) – 要檢查的值。

cardinality() → int¶

規格的基數。

這指的是規格中可能結果的數量。假設複合規格的基數是所有可能結果的笛卡爾積。

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

返回一個新的規格，移除所有大小為 1 的維度。

當指定 dim 時，僅在該維度進行 squeeze 操作。

引數：:: dim (int 或 None) – 應用 squeeze 操作的維度

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

將 TensorSpec 轉換為裝置或 dtype。

如果沒有更改，則返回相同的規格。

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

將給定的獨熱 (one-hot) 張量轉換為分類格式。

引數：:

val (torch.Tensor, 可選) – 要轉換為分類格式的獨熱 (One-hot) 張量。
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) – 需要檢查 dtype 的張量。
key (str, 可選) – 如果 TensorSpec 具有鍵，則將對照由指定鍵指向的規格檢查值的 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，則停用掩碼。否則，掩碼的形狀必須可擴充套件到 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: torch.Size = None) → torch.Tensor | TensorDictBase¶

返回 Spec 中填充零的張量。

注意

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

引數：:: shape (torch.Size) – 零張量的形狀
返回：:: 在 TensorSpec 範圍內取樣的填充零的張量。

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: zero() 的代理方法。

MultiOneHotDiscreteTensorSpec¶

文件

教程

資源