BoundedTensorSpec

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

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

assert_is_in(value: Tensor) → None

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

引數:

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

cardinality() → int

規格的基數。

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

clear_device_() → T

對所有葉子規格而言，這是一個無操作 (no-op)（它們必須有一個裝置）。

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

clone() → Bounded

建立 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 或 torch.Tensor) – 要編碼為張量的值。

關鍵字引數:

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

返回值:

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

enumerate() → Any

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

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

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

expand(*shape)

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

引數:

*shape (tuple 或 iterable of int) – 規格的新形狀。必須與當前形狀可廣播：其長度必須至少與當前形狀長度相同，並且其最後一個值也必須相容；即只有噹噹前維度為 1 時，它們才能與其不同。

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)

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

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

引數:

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

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

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

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

解除展平 TensorSpec。

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

unsqueeze(dim: int)

返回一個新的 Spec，其中包含一個額外的單例維度（位於由 dim 指示的位置）。

引數:

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

view(*shape) → T

重塑一個 TensorSpec。

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

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

返回在邊界框內的零填充張量。

注意

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

引數:

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

返回值:

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

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

對 zero() 的代理。