NonTensor

class torchrl.data.NonTensor(shape: Union[torch.Size, int] = torch.Size([1]), device: Optional[DEVICE_TYPING] = None, dtype: torch.dtype | None = None, example_data: Any = None, **kwargs)

非張量資料的規格。

此規格具有形狀、裝置和資料型別，類似於 NonTensorData。

rand() 將返回一個數據值為 None 的 NonTensorData 物件。（zero() 和 one() 也一樣。）

注意

NonTensor 的預設形狀是 (1,)。

assert_is_in(value: Tensor) → None

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

引數：

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

cardinality() → Any

規格的基數。

這指的是規格中可能結果的數量。複合規格的基數被認為是所有可能結果的笛卡爾積。

clear_device_() → T

對於所有葉子規格（必須有裝置），此操作不執行任何動作（no-op）。

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

clone() → NonTensor

建立 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 或 TensorDictBase。

enumerate() → Any

返回可以從 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: Any) → 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=None)

返回範圍內一個填充為 1 的張量。

注意

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

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

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

引數：

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

返回值：

在 TensorSpec 範圍內取樣的隨機張量。

reshape(*shape) → T

重塑 TensorSpec 的形狀。

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

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

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

詳細資訊請參見 rand()。

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

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

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

引數：

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

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

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

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

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

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

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

引數：

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

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

返回值：

一個 np.ndarray。

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

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

引數：

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

view(*shape) → T

重塑 TensorSpec 的形狀。

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

zero(shape=None)

在指定的框中返回一個用零填充的張量。

注意

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

引數：

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

返回值：

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

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

zero() 的代理。