堆疊 (Stacked)

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

張量規格堆疊的延遲表示法。

沿一個維度將張量規格堆疊在一起。 繪製隨機樣本時，如果可能，則返回樣本堆疊。 否則，會拋出錯誤。

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

此類別旨在用於多任務和多代理設定，在這些設定中，可能會出現異構規格（語義相同但形狀不同）。

assert_is_in(value: Tensor) → None

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

參數:

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

clear_device_()

清除複合體的裝置。

clone() → T

建立 TensorSpec 的副本。

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

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

更多資訊請參閱 is_in()。

cpu()

將 TensorSpec 轉換為 'cpu' 裝置。

cuda(device=None)

將 TensorSpec 轉換為 'cuda' 裝置。

property device: Union[device, str, int]

Spec 的裝置。

只有 Composite specs 可以有 None 裝置。所有 leaves 必須有一個非空的裝置。

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

根據指定的 spec 編碼一個值，並返回相應的張量。

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

參數:

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

關鍵字參數：

ignore_device (bool, optional) – 如果 True，將忽略 spec 裝置。 這用於在呼叫 TensorDict(..., device="cuda") 中分組張量轉換，這樣速度更快。

返回值：

符合所需張量 specs 的 torch.Tensor。

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 函數覆蓋。

abstract index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: torch.Tensor | tensordict.base.TensorDictBase) → torch.Tensor | tensordict.base.TensorDictBase

索引輸入張量。

參數:

• index (int, torch.Tensor, slice 或 list) – 張量的索引

• tensor_to_index – 要索引的張量

返回值：

已索引的張量

is_in(value) → bool

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

更精確地說，is_in 方法會檢查數值 val 是否在 space 屬性（此方框）定義的範圍內，並且 dtype、device、shape 以及潛在的其他元數據是否與 spec 的相符。如果其中任何一項檢查失敗，is_in 方法將會傳回 False。

參數:

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

返回值：

布林值，表示數值是否屬於 TensorSpec 方框。

make_neg_dim(dim: int)

將特定維度轉換為 -1。

property ndim

Spec 形狀的維度數量。

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

ndimension()

Spec 形狀的維度數量。

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

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

傳回方框中填滿 1 的張量。

注意

即使無法保證 1 屬於 spec 域，但當違反此條件時，此方法不會引發例外。 one 的主要用途是生成空的資料緩衝區，而不是有意義的資料。

參數:

shape (torch.Size) – one-tensor 的形狀

返回值：

在 TensorSpec 方框中取樣的填滿 1 的張量。

ones(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

代理 one()。

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

如果輸入張量不在 TensorSpec 方框中，則使用一些定義的啟發法將其映射回該方框。

參數:

val (torch.Tensor) – 要映射到方框的張量。

返回值：

屬於 TensorSpec 方框的 torch.Tensor。

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

傳回 spec 定義的空間中的隨機張量。

除非方框是無界的，否則將在空間上均勻地完成取樣，在這種情況下，將會提取常態值。

參數:

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

返回值：

在 TensorSpec 方框中取樣的隨機張量。

reshape(*shape) → T

重塑 TensorSpec。

請參考 reshape() 以取得此方法的更多資訊。

sample(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

傳回 spec 定義的空間中的隨機張量。

請參考 rand() 以取得詳細資訊。

squeeze(dim: Optional[int] = None)

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

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

參數:

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

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

將 TensorSpec 轉換為裝置或 dtype。

如果沒有進行任何變更，則傳回相同的 spec。

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

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

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

參數:

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

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

返回值：

一個 np.ndarray。

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

根據 TensorSpec dtype 檢查輸入值 dtype，如果不匹配則引發例外。

參數:

• value (torch.Tensor) – 必須檢查其 dtype 的張量。

• key (str, optional) – 如果 TensorSpec 具有鍵，則將根據指示鍵指向的 spec 檢查值 dtype。

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

展開一個 TensorSpec。

請參考 unflatten() 以取得此方法的更多資訊。

unsqueeze(dim: int)

返回一個新的 Spec，它在指定的位置（由 dim 指示）增加一個 singleton 維度。

參數:

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

view(*shape) → T

重塑 TensorSpec。

請參考 reshape() 以取得此方法的更多資訊。

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

返回一個框中填滿零的張量。

注意

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

參數:

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

返回值：

在 TensorSpec 框中採樣的填滿零的張量。

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

Proxy to zero().