UnboundedDiscrete

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

torchrl.data.Unbounded 的一個特化版本，具有離散空間。

assert_is_in(value: Tensor) → None

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

引數：

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' 裝置。

屬性 device: device

spec 的裝置。

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

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

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

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

引數：

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

關鍵字引數：

ignore_device (bool, *可選*) – 如果為 True，則忽略 spec 裝置。這用於在呼叫 TensorDict(..., device="cuda") 時對張量轉換進行分組，這樣更快。

返回：

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

enumerate() → Any

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

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

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

expand(*shape)

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

引數：

*shape (tuple 或 int 可迭代物件) – Spec 的新形狀。必須與當前形狀可廣播：其長度必須至少與當前形狀長度相等，並且其最後一個值也必須相容；即，它們只能在當前維度是單例時與之不同。

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

展平 TensorSpec。

查閱 flatten() 瞭解關於此方法的更多資訊。

類方法 implements_for_spec(torch_function: Callable) → Callable

為 TensorSpec 註冊一個 torch 函式覆蓋。

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

對輸入張量進行索引。

此方法用於編碼一個或多個分類變數的 spec (例如，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 以及可能的其他元資料是否與 spec 的匹配。如果其中任何一項檢查失敗，is_in 方法將返回 False。

引數：

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

返回：

布林值，指示值是否屬於 TensorSpec 框。

make_neg_dim(dim: int) → T

將指定維度轉換為 -1。

屬性 ndim: int

spec 形狀的維度數量。

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

ndimension() → int

spec 形狀的維度數量。

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

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

返回框中一個填滿 1 的張量。

注意

即使不能保證 1 屬於 spec 領域，當違反此條件時，此方法不會引發異常。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

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

取樣將均勻地在空間中進行，除非框是無界的，在這種情況下將抽取正態分佈的值。

引數：

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

返回：

在 TensorSpec 框中取樣的隨機張量。

reshape(*shape) → T

重塑 TensorSpec。

查閱 reshape() 瞭解關於此方法的更多資訊。

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

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

參閱 rand() 瞭解詳情。

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

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

當給出 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 匹配，如果不匹配則引發異常。

引數：

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

• key (str, optional) – 如果 TensorSpec 包含鍵，則會根據指定鍵指向的 Spec 來檢查 value 的 dtype。

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

對 TensorSpec 進行 unflatten 操作。

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

unsqueeze(dim: int) → T

返回一個新的 Spec，並在 dim 指定的位置增加一個單例維度。

引數：

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

view(*shape) → T

重塑 TensorSpec。

查閱 reshape() 瞭解關於此方法的更多資訊。

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

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

注意

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

引數：

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

返回：

在該 TensorSpec 定義的範圍內取樣的一個用零填充的張量。

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

zero() 方法的別名。