DiscreteTensorSpec

class torchrl.data.DiscreteTensorSpec(*args, **kwargs)

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

assert_is_in(value: Tensor) → None

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

引數：

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

cardinality() → int

此 spec 的基數。

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

clear_device_() → T

對於所有葉子 spec（必須有裝置），此方法是空操作（no-op）。

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

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

根據指定的 spec 對值進行編碼，並返回相應的張量。

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

引數：

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

關鍵字引數：

ignore_device (bool, 可選) – 如果為 True，將忽略 spec 裝置。這用於將張量轉換分組在 TensorDict(..., device="cuda") 呼叫內，後者速度更快。

返回：

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

enumerate() → Tensor

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

樣本將沿著第一維堆疊。

此方法僅針對離散 spec 實現。

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）的 spec，這樣就可以用樣本對張量進行索引，而無需關心索引的實際表示形式。

引數：

• 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 屬性（即範圍 box）定義的限制內，並且 dtype、device、shape 以及其他可能的元資料與 spec 的匹配。如果任何這些檢查失敗，is_in 方法將返回 False。

引數：

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

返回：

一個布林值，指示值是否屬於 TensorSpec 範圍（box）。

make_neg_dim(dim: int) → T

將特定維度轉換為 -1。

property ndim: int

spec 形狀的維數。

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

ndimension() → int

spec 形狀的維數。

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

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

返回範圍（box）內填充為一的張量。

注意

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

引數：

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

返回：

在 TensorSpec 範圍（box）內取樣的填充為一的張量。

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

one() 的代理方法。

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

如果輸入張量不在 TensorSpec 範圍（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: torch.Size = None) → torch.Tensor | TensorDictBase

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

詳情請參閱 rand()。

set_provisional_n(n: int)

臨時設定 Categorical spec 的基數。

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

引數：

n (int) – Categorical spec 的基數。

squeeze(dim=None)

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

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

引數：

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

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

將 TensorSpec 轉換為裝置或 dtype。

如果未進行更改，則返回相同的 spec。

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

對 categorical 是空操作（no-op）。

to_categorical_spec() → Categorical

對 categorical 是空操作（no-op）。

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

將規範域中的離散張量編碼為其對應的獨熱形式。

引數：

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

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

返回：

獨熱編碼後的張量。

示例

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

將此規範轉換為等價的獨熱規範。

示例

>>> 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) – 需要檢查資料型別的張量。

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

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

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

返回規範域中填充零的張量。

注意

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

引數：

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

返回：

在 TensorSpec 規範域中取樣的填充零的張量。

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

zero() 的代理。