Categorical

class torchrl.data.Categorical(n: int, shape: torch.Size | None = None, device: DEVICE_TYPING | None = None, dtype: str | torch.dtype = torch.int64, mask: torch.Tensor | None = None)

一種離散張量規範。

TorchRL 中分類變數的 OneHot 的替代方案。分類變數執行索引而不是掩碼，這可以加快大型分類變數的計算速度並降低記憶體成本。

此規範將具有由 shape 引數定義的形狀：如果希望訓練維度採用單例維度，則應明確指定。

變數：

• n (int) – 可能結果的數量。

• shape (torch.Size) – 變數的形狀。

• device (torch.device) – 張量所在的裝置。

• dtype (torch.dtype) – 張量的資料型別。

引數：

• n (int) – 可能結果的數量。如果設定為 -1，則分類規範的基數未定義，必須在此規範取樣之前呼叫 set_provisional_n。

• shape – (torch.Size, optional): 變數的形狀，預設為 “torch.Size([])”。

• device (str, int 或 torch.device, optional) – 張量所在的裝置。

• dtype (str 或 torch.dtype, optional) – 張量的資料型別。

• mask (torch.Tensor 或 None) – 一個布林掩碼，用於在取樣時阻止某些可能結果。有關更多資訊，請參閱 update_mask()。

示例

>>> categ = Categorical(3)
>>> categ
Categorical(
    shape=torch.Size([]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.int64,
    domain=discrete)
>>> categ.rand()
tensor(2)
>>> categ = Categorical(3, shape=(1,))
>>> categ
Categorical(
    shape=torch.Size([1]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.int64,
    domain=discrete)
>>> categ.rand()
tensor([1])
>>> categ = Categorical(-1)
>>> categ.set_provisional_n(5)
>>> categ.rand()
tensor(3)

注意

當 n 設定為 -1 時，如果在未先使用 set_provisional_n 設定臨時 n 的情況下呼叫 rand，將引發 RuntimeError。

assert_is_in(value: Tensor) → None

斷言張量是否屬於該箱，否則引發異常。

引數：

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

cardinality() → int

規範的基數。

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

clear_device_() → T

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

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

clone() → Categorical

建立 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, optional) – 如果為 True，將忽略規範裝置。這用於在呼叫 TensorDict(..., device="cuda") 時分組張量轉換，這樣速度更快。

返回：

與所需張量規範匹配的 torch.Tensor。

enumerate() → Tensor

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

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

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

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 函式覆蓋。

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

索引輸入張量。

此方法用於編碼一個或多個分類變數的規範（例如，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 屬於規範域，當此條件違反時，此方法也不會引發異常。one 的主要用例是生成空資料緩衝區，而不是有意義的資料。

引數：

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

返回：

在 TensorSpec 範圍中取樣的填充一的張量。

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: Optional[Size] = None) → torch.Tensor | TensorDictBase

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

詳見 rand()。

set_provisional_n(n: int)

臨時設定 Categorical 規範的基數。

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

引數：

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

squeeze(dim=None)

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

給定 dim 時，僅在該維度上執行擠壓操作。

引數：

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

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

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

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

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

對於 categorical 是空操作。

to_categorical_spec() → Categorical

對於 categorical 是空操作。

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) → Tensor

將來自 spec 域的離散張量編碼為其 one-hot 對應形式。

引數：

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

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

返回：

one-hot 編碼後的張量。

示例

>>> categ = Categorical(3)
>>> categ_sample = categ.zero()
>>> categ_sample
tensor(0)
>>> onehot_sample = categ.to_one_hot(categ_sample)
>>> onehot_sample
tensor([ True, False, False])

to_one_hot_spec() → OneHot

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

示例

>>> categ = Categorical(3)
>>> categ.to_one_hot_spec()
OneHot(
    shape=torch.Size([3]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

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，它增加了一個大小為 1 的維度（位於由 dim 指示的位置）。

引數：

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

update_mask(mask)

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

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

引數：

mask (torch.Tensor 或 None) – 布林掩碼。如果為 None，則停用掩碼。否則，掩碼的形狀必須可擴充套件到等效 one-hot 規範的形狀。False 遮蔽一個結果，True 則不遮蔽該結果。如果所有可能的結果都被遮蔽，則在取樣時會引發錯誤。

示例

>>> mask = torch.tensor([True, False, True])
>>> ts = Categorical(3, (10,), dtype=torch.int64, mask=mask)
>>> # One of the three possible outcomes is masked
>>> ts.rand()
tensor([0, 2, 2, 0, 2, 0, 2, 2, 0, 2])

view(*shape) → T

重塑 TensorSpec。

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

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

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

注意

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

引數：

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

返回：

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

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

zero() 的代理。