MultiCategorical¶

class torchrl.data.MultiCategorical(nvec: Union[Sequence[int], torch.Tensor, int], shape: Optional[torch.Size] = None, device: Optional[DEVICE_TYPING] = None, dtype: Optional[Union[str, torch.dtype]] = torch.int64, mask: torch.Tensor | None = None, remove_singleton: bool = True)[source]¶

離散張量規範的串聯。

引數:

nvec (整數可迭代物件 或 torch.Tensor) – 張量中每個元素的基數。可以有多個軸。
shape (torch.Size, 可選) – 取樣張量的總形狀。如果提供，最後 m 個維度必須與 nvec.shape 匹配。
device (str, int 或 torch.device, 可選) – 張量所在的裝置。
dtype (str 或 torch.dtype, 可選) – 張量的資料型別。
remove_singleton (bool, 可選) – 如果為 True，則大小為 [1] 的單例樣本將被壓縮。預設為 True。
mask (torch.Tensor 或 None) – 在取樣時遮蓋部分可能的結果。詳情請參閱 update_mask()。

示例

>>> ts = MultiCategorical((3, 2, 3))
>>> ts.is_in(torch.tensor([2, 0, 1]))
True
>>> ts.is_in(torch.tensor([2, 10, 1]))
False

assert_is_in(value: Tensor) → None¶

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

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

cardinality() → int[source]¶

規範的基數。

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

clear_device_() → T¶

對所有葉子規範（必須有裝置）來說是空操作。

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

clone() → MultiCategorical[source]¶: 建立 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: np.ndarray | torch.Tensor | TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | TensorDictBase¶

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

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

引數:: val (np.ndarray 或 torch.Tensor) – 要編碼為張量的值。
關鍵字引數:: ignore_device (bool, 可選) – 如果為 True，則忽略規範裝置。這用於將張量轉換分組在呼叫 TensorDict(..., device="cuda") 內，這樣速度更快。
返回值:: 匹配所需張量規範的 torch.Tensor。

enumerate() → Tensor[source]¶

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

樣本將沿第一維度堆疊。

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

expand(*shape)[source]¶

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

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

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

展平 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable¶: 為 TensorSpec 註冊一個 torch 函式覆蓋。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase¶

對輸入張量進行索引。

此方法用於編碼一個或多個分類變數的規範（例如 OneHot 或 Categorical），這樣可以使用樣本對張量進行索引，而無需關心索引的實際表示。

引數:

index (int, torch.Tensor, 切片或 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[source]¶

如果值 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[source]¶

返回由規範定義的空間中的隨機張量。

取樣將均勻地分佈在空間中，除非該範圍無界，此時將抽取正態分佈的值。

引數:: shape (torch.Size) – 隨機張量的形狀
返回值:: 在 TensorSpec 範圍內取樣的隨機張量。

reshape(*shape) → T¶

重塑 TensorSpec。

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

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

返回由規範定義的空間中的隨機張量。

詳細資訊請參閱 rand()。

set_provisional_n(n: int)¶

臨時設定 Categorical 規範的基數。

當 n 為 -1 時，必須在從規範取樣之前呼叫此方法。

引數:: n (int) – Categorical 規範的基數。

squeeze(dim: int | None = None)[source]¶

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

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

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

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

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

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

to_categorical(val: Tensor, safe: Optional[bool] = None) → MultiCategorical[源]¶: 不適用於 MultiCategorical。

to_categorical_spec() → MultiCategorical[源]¶: 不適用於 MultiCategorical。

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

返回輸入 Tensor 對應的 np.ndarray。

這被認為是 encode() 操作的逆操作。

引數:

val (torch.Tensor) – 要轉換為 numpy 的 Tensor。
safe (bool) – 布林值，指示是否針對 spec 的域對值進行檢查。預設為 CHECK_SPEC_ENCODE 環境變數的值。

返回值:

一個 np.ndarray。

to_one_hot(val: Tensor, safe: Optional[bool] = None) → Union[MultiOneHot, Tensor][源]¶

將 spec 域中的離散 Tensor 編碼為其對應的獨熱 (one-hot) 表示。

引數:

val (torch.Tensor, optional) – 要進行獨熱編碼的 Tensor。
safe (bool) – 布林值，指示是否針對 spec 的域對值進行檢查。預設為 CHECK_SPEC_ENCODE 環境變數的值。

返回值:

獨熱編碼後的 Tensor。

to_one_hot_spec() → MultiOneHot[源]¶: 將 spec 轉換為等效的獨熱 spec。

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

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

引數:

value (torch.Tensor) – 需要檢查 `dtype` 的 Tensor。
key (str, optional) – 如果 `TensorSpec` 包含鍵，則將根據指定鍵指向的 spec 檢查值的 `dtype`。

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

對 TensorSpec 進行 unflatten 操作（逆展平）。

請檢視 unflatten() 瞭解有關此方法的更多資訊。

unsqueeze(dim: int)[源]¶

返回一個帶有額外單維度的新 Spec（位於由 dim 指定的位置）。

引數:: dim (int or None) – 要應用 unsqueeze 操作的維度。

update_mask(mask)[源]¶

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

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

引數:: mask (torch.Tensor or None) – 布林掩碼。如果為 None，則停用掩碼。否則，掩碼的形狀必須可以擴充套件到等效獨熱 spec 的形狀。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: torch.Size = None) → torch.Tensor | TensorDictBase¶

返回 spec 範圍內的零填充 Tensor。

注意

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

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

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

MultiCategorical¶

文件

教程

資源