UnboundedDiscreteTensorSpec

類 torchrl.data.UnboundedDiscreteTensorSpec(*args, **kwargs)

torchrl.data.Unbounded 的已棄用版本，用於離散空間。

assert_is_in(value: Tensor) → None

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

引數:

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

cardinality() → int

Spec 的基數。

這是指一個 spec 中可能結果的數量。假設組合 spec 的基數是所有可能結果的笛卡爾積。

clear_device_() → T

對於所有葉子 spec（必須具有裝置資訊）而言，這是一個空操作。

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

clone() → Unbounded

建立 TensorSpec 的副本。

contains(item: torch.Tensor | TensorDictBase) → bool

如果值 val 可以由 TensorSpec 生成，則返回 True，否則返回 False。

有關更多資訊，請參閱 is_in()。

cpu()

將 TensorSpec 轉換為 'cpu' 裝置。

cuda(device=None)

將 TensorSpec 轉換為 'cuda' 裝置。

property device: device

Spec 的裝置。

只有 Composite spec 的裝置可以為 None。所有葉子都必須具有非空裝置。

encode(val: np.ndarray | torch.Tensor | TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | TensorDictBase

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

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

引數:

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

關鍵字引數:

ignore_device (bool, 可選) – 如果為 True，將忽略 spec 的裝置資訊。這用於在呼叫 TensorDict(..., device="cuda") 中將張量型別轉換分組，從而更快。

返回:

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

enumerate() → Any

返回可以從 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 註冊一個 PyTorch 函式過載。

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

對輸入張量進行索引。

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

引數:

• index (int, torch.Tensor, 切片 或 列表) – 張量的索引

• 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

返回一個範圍內的全一張量。

注意

即使不能保證 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 中，它會根據一些定義的啟發式方法將其映射回 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: Optional[Size] = None) → torch.Tensor | TensorDictBase

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

有關詳細資訊，請參閱 rand()。

squeeze(dim: int | None = None) → T

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

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

引數:

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

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

將 TensorSpec 轉換為指定的裝置或 dtype。

如果沒有發生更改，則返回相同的 spec。

to_numpy(val: torch.Tensor | TensorDictBase, safe: bool = None) → np.ndarray | dict

返回輸入張量對應的 np.ndarray。

這旨在作為 encode() 的逆操作。

引數:

• val (torch.Tensor) – 要轉換為 numpy 的張量。

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

返回:

一個 np.ndarray。

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

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

引數:

• 值 (torch.Tensor) – 需要檢查其 dtype 的張量。

• 鍵 (str, optional) – 如果 TensorSpec 有鍵，則將根據指定鍵指向的 spec 來檢查值的 dtype。

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

將一個 TensorSpec 取消展平。

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

unsqueeze(dim: int) → T

返回一個新的 Spec，它增加了一個單例維度（在由 dim 指定的位置）。

引數:

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

view(*shape) → T

重塑 TensorSpec。

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

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

返回 spec 框內的零填充張量。

注意

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

引數:

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

返回:

在 TensorSpec 框內取樣的零填充張量。

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

是 zero() 的代理。