UnboundedContinuousTensorSpec

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

已棄用版本，對應於 torchrl.data.Unbounded 的連續空間。

assert_is_in(value: Tensor) → None

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

引數:

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

cardinality() → int

規範的基數。

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

clear_device_() → T

對所有葉子規範而言，這是一個無操作 (它們必須有裝置)。

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

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

規範的裝置。

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

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

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

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

引數:

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

關鍵字引數:

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

返回:

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

enumerate() → Any

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

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

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

expand(*shape)

返回具有展開形狀的新規範。

引數:

*shape (tuple 或 int 可迭代物件) – 規範的新形狀。必須與當前形狀可廣播：其長度必須至少與當前形狀長度相同，並且其最後一個值也必須符合要求；也就是說，它們只有在當前維度是單例時才能與當前形狀不同。

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

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

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

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

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

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

引數:

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

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

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

如果未做任何更改，則返回相同的規範。

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

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

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

引數:

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

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

返回:

一個 np.ndarray。

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

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

引數:

• value (torch.Tensor) – 需要檢查資料型別的張量。

• key (str, 可選的) – 如果 TensorSpec 包含鍵，則將對照指定鍵指向的 spec 檢查值的資料型別。

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

展開一個 TensorSpec。

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

unsqueeze(dim: int) → T

返回一個在指定維度 (`dim`) 處增加一個單維度的新 Spec。

引數:

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

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() 的代理。