Stacked

class torchrl.data.Stacked(*specs: Tuple[T, ...], dim: int)

棧張量規格的惰性表示。

沿一個維度將張量規格堆疊在一起。當抽取隨機樣本時，如果可能，將返回一個樣本棧。否則，將丟擲錯誤。

允許索引，但只能沿堆疊維度進行。

此類旨在用於多工和多智慧體設定，其中可能出現異構規格（語義相同但形狀不同）。

assert_is_in(value: Tensor) → None

斷言張量是否屬於指定的範圍，否則丟擲異常。

引數：

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

cardinality(*args, **kwargs) → Any

規格的基數。

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

clear_device_()

清除 Composite 的裝置設定。

clone() → T

建立 TensorSpec 的副本。

contains(item: torch.Tensor | TensorDictBase) → bool

如果值 val 可以由 TensorSpec 生成，則返回 True，否則返回 False。

有關更多資訊，請參閱 is_in()。

cpu()

將 TensorSpec 轉換到 ‘cpu’ 裝置。

cuda(device=None)

將 TensorSpec 轉換到 ‘cuda’ 裝置。

property device: Union[device, str, int]

規格的裝置。

只有 Composite 規格可以具有 None 裝置。所有葉節點都必須具有非空裝置。

encode(val: Union[ndarray, Tensor], *, ignore_device=False) → Tensor

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

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

引數：

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

關鍵字引數：

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

返回：

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

enumerate() → torch.Tensor | TensorDictBase

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

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

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

expand(*shape)

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

引數：

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

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(value) → bool

如果值 val 可以由 TensorSpec 生成，則返回 True，否則返回 False。

更準確地說，is_in 方法檢查值 val 是否在 space 屬性（即 box）定義的限制範圍內，並且 dtype、device、shape 以及可能其他元資料與規格匹配。如果任何檢查失敗，is_in 方法將返回 False。

引數：

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

返回：

布林值，指示值是否屬於 TensorSpec 的 box 範圍。

make_neg_dim(dim: int)

將特定維度轉換為 -1。

property ndim

規格形狀的維度數量。

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

ndimension()

規格形狀的維度數量。

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

one(shape: Optional[Size] = None) → TensorDictBase

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

注意

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

引數：

shape (torch.Size) – 該填充為 1 的張量的形狀

返回：

在 TensorSpec 的 box 範圍內取樣的、填充為 1 的張量。

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

one() 的代理。

project(val: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase

如果輸入張量不在 TensorSpec 的 box 範圍內，它會根據某個已定義的啟發式方法將其映射回 box 範圍。

引數：

val (torch.Tensor) – 要對映到 box 範圍內的張量。

返回：

屬於 TensorSpec 的 box 範圍內的 torch.Tensor。

rand(shape: Optional[Size] = None) → TensorDictBase

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

取樣將在空間上均勻完成，除非 box 是無界的，在這種情況下將抽取正態分佈值。

引數：

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

返回：

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

reshape(*shape) → T

重塑 TensorSpec。

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

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

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

詳情請參閱 rand()。

squeeze(dim: Optional[int] = None)

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

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

引數：

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

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

將 TensorSpec 轉換到裝置或 dtype。

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

to_numpy(val: Tensor, safe: Optional[bool] = None) → dict

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

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

引數：

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

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

返回：

一個 np.ndarray。

type_check(value: torch.Tensor, key: NestedKey | None = 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)

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

引數：

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

view(*shape) → T

重塑 TensorSpec。

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

zero(shape: Optional[Size] = None) → TensorDictBase

返回一個填充了零的張量（在 box 中）。

注意

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

引數：

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

返回：

在 TensorSpec box 中取樣的填充了零的張量。

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

zero() 的代理。