TensorSpec

class torchrl.data.TensorSpec(shape: ~torch.Size, space: ~typing.Union[None, ~torchrl.data.tensor_specs.Box], device: torch.device | None = <property object>, dtype: ~torch.dtype = torch.float32, domain: str = '')

張量元資料容器的父類別。

TorchRL 的 TensorSpec 用於呈現特定類別預期的輸入/輸出，或者有時透過在定義的空間內產生隨機資料來模擬簡單行為。

TensorSpec 主要用於環境中，以指定其輸入/輸出結構，而無需執行環境 (或啟動它)。 它們也可以用於實例化共享緩衝區，以將資料從工作程式傳遞到工作程式。

TensorSpec 是資料類別，始終共享以下欄位：shape、space、dtype 和 device。

因此，TensorSpec 與 Tensor 和 TensorDict 具有一些常見行為：它們可以被重塑、索引、擠壓、取消擠壓、移動到另一個裝置等。

參數:

• shape (torch.Size) – 張量的大小。 形狀包括批次維度以及特徵維度。 負形狀 (-1) 表示該維度具有可變數量的元素。

• space (Box) – Box 實例，描述可以預期的值類型。

• device (torch.device) – 張量的裝置。

• dtype (torch.dtype) – 張量的 dtype。

注意

可以使用 make_composite_from_td() 函數從 TensorDict 構造一個 spec。 該函數對可能對應於輸入張量字典的 spec 進行低假設的合理猜測，並且可以幫助自動構建 spec，而無需深入了解 TensorSpec API。

assert_is_in(value: Tensor) → None

斷言張量是否屬於此範圍，否則引發例外。

參數:

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

clear_device_() → T

對於所有葉節點規格（必須具有裝置）來說，這是一個空操作。

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

abstract clone() → TensorSpec

建立 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: device

規格的裝置。

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

encode(val: numpy.ndarray | torch.Tensor | tensordict.base.TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | tensordict.base.TensorDictBase

根據指定的規格編碼一個值，並傳回相應的張量。

此方法用於回傳值（例如，一個 numpy 陣列）可以輕鬆對應到 TorchRL 所需領域的環境中。如果該值已經是一個張量，則規格將不會更改其值，並按原樣傳回它。

參數:

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

關鍵字參數：

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

傳回：

符合所需張量規格的 torch.Tensor。

abstract expand(shape: Size)

傳回具有展開形狀的新規格。

參數:

*shape (tuple 或 int 的 iterable) – 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 – 要建立索引的張量

傳回：

已建立索引的張量

abstract is_in(val: torch.Tensor | tensordict.base.TensorDictBase) → 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) → T

將特定維度轉換為 -1。

property ndim: int

spec 形狀的維度數。

len(spec.shape) 的捷徑。

ndimension() → int

spec 形狀的維度數。

len(spec.shape) 的捷徑。

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

傳回框中填滿 1 的張量。

注意

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

參數:

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

傳回：

在 TensorSpec box 中取樣的一個填滿 1 的 tensor。

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

是 one() 的代理。

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

如果輸入的 tensor 不在 TensorSpec box 中，則會使用一些定義好的啟發式方法將其映射回 box 中。

參數:

val (torch.Tensor) – 要映射到 box 中的 tensor。

傳回：

屬於 TensorSpec box 的 torch.Tensor。

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

傳回在 spec 定義的空間中的隨機 tensor。

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

參數:

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

傳回：

在 TensorSpec box 中取樣的一個隨機 tensor。

reshape(shape) → T

重塑 (reshape) 一個 TensorSpec。

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

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

傳回在 spec 定義的空間中的隨機 tensor。

請參閱 rand() 了解詳細資訊。

squeeze(dim: Optional[int] = None) → T

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

當給定 dim 時，僅在該維度上執行 squeeze 運算。

參數:

dim (int 或 None) – 應用 squeeze 運算的維度

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

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

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

to_numpy(val: torch.Tensor | tensordict.base.TensorDictBase, safe: Optional[bool] = None) → numpy.ndarray | 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

檢查輸入值 dtype 是否符合 TensorSpec 的 dtype，如果不符合，則引發例外。

參數:

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

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

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

將 TensorSpec 取消扁平化。

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

unsqueeze(dim: int) → T

傳回一個新的 Spec，其中包含一個額外的單位維度 (位於 dim 指示的位置)。

參數:

dim (int 或 None) – 要對其應用 unsqueeze 運算的維度。

view(*shape) → T

重塑 (reshape) 一個 TensorSpec。

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

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

傳回框中填滿零的張量。

注意

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

參數:

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

傳回：

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

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

是 zero() 的代理。