NonTensorSpec

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

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

assert_is_in(value: Tensor) → None

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

引數:

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

cardinality() → Any

規範的基數。

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

clear_device_() → T

所有葉子規範（必須有裝置）的無操作方法。

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

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

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

引數:

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

關鍵字引數:

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

返回:

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

enumerate() → Any

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

樣本將沿第一維度堆疊。

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

expand(*shape)

返回具有擴充套件形狀的新規範。

引數:

*shape (tuple or iterable of 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 or 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 屬於規範域，當違反此條件時，此方法也不會引發異常。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=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

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

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

引數:

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

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

將 TensorSpec 投射到裝置或 dtype。

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

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, optional) – 如果 TensorSpec 有鍵，則將對照指定鍵指向的規範檢查值的 dtype。

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

解展平 TensorSpec。

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

unsqueeze(dim: int) → NonTensor

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

引數:

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

view(*shape) → T

重塑 TensorSpec。

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

zero(shape=None)

返回一個填充零的張量。

注意

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

引數:

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

返回:

一個在 TensorSpec 範圍內取樣並填充了零的張量。

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

zero() 方法的代理。