TensorSpec

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

張量元資料容器的父類。

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

TensorSpecs 主要用於環境中，以便在無需執行環境（或啟動環境）的情況下指定其輸入/輸出結構。它們也可用於例項化共享緩衝區，以便在工作程序之間傳遞資料。

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

因此，TensorSpecs 與 Tensor 和 TensorDict 具有一些共同的行為：它們可以被重塑（reshape）、索引（index）、壓縮（squeeze）、解壓縮（unsqueeze）、移動到另一個裝置等。

引數:

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

• space (Box) – 描述預期值型別的 Box 例項。

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

• dtype (torch.dtype) – 張量的資料型別。

注意

可以使用 make_composite_from_td() 函式從 TensorDict 構建一個 spec。此函式會根據輸入的 tensordict 進行低假設的有根據的猜測，以構建可能對應的 spec，並可幫助在無需深入瞭解 TensorSpec API 的情況下自動構建 spec。

assert_is_in(value: Tensor) → None

斷言張量是否屬於 Box，否則丟擲異常。

引數:

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

abstract cardinality() → int

spec 的基數（cardinality）。

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

clear_device_() → T

對所有葉子 spec（必須有裝置）來說是空操作（no-op）。

對於 Composite spec，此方法將抹去裝置資訊。

abstract clone() → TensorSpec

建立 TensorSpec 的副本。

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

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

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

cpu()

將 TensorSpec 轉換為 ‘cpu’ 裝置。

cuda(device=None)

將 TensorSpec 轉換為 ‘cuda’ 裝置。

property device: device

spec 的裝置。

只有 Composite spec 可以有 None 裝置。所有葉子 spec 都必須有非空裝置。

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

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

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

引數:

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

關鍵字引數:

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

返回:

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

abstract enumerate() → Any

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

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

此方法僅針對離散 spec 實現。

abstract expand(shape: Size)

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

引數:

*shape (tuple or iterable of int) – Spec 的新形狀。必須與當前形狀可廣播（broadcastable）：其長度必須至少與當前形狀長度相同，並且其最後一個值也必須相容；即，僅噹噹前維度是單例（singleton）時，它們才能與當前形狀不同。

flatten(start_dim: int, end_dim: int) → T

展平（flatten）一個 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

為 TensorSpec 註冊一個 torch 函式覆蓋。

abstract index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase

索引輸入張量。

此方法用於編碼一個或多個分類變數（例如 OneHot 或 Categorical）的 spec，以便可以使用樣本對張量進行索引，而無需關心索引的實際表示。

引數:

• 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)

abstract is_in(val: torch.Tensor | TensorDictBase) → bool

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

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

引數:

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

返回:

布林值，指示值是否屬於 TensorSpec 的 Box。

make_neg_dim(dim: int) → T

將特定維度轉換為 -1。

property ndim: int

spec 形狀的維度數。

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

ndimension() → int

spec 形狀的維度數。

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

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

返回 Box 中填充了 1 的張量。

注意

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

引數:

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

返回:

在 TensorSpec Box 中取樣的一個填充 1 的張量。

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

是 one() 的代理（Proxy）。

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

如果輸入張量不在 TensorSpec Box 中，則根據某些定義的啟發式將其映射回 Box 中。

引數:

val (torch.Tensor) – 要對映到 Box 的張量。

返回:

屬於 TensorSpec Box 的 torch.Tensor。

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

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

取樣將在空間中均勻進行，除非 Box 無界，在這種情況下將抽取正態值。

引數:

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

返回:

在 TensorSpec Box 中取樣的隨機張量。

reshape(shape) → T

重塑（reshape）一個 TensorSpec。

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

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

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

詳細資訊請參見 rand()。

squeeze(dim: int | None = None) → T

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

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

引數:

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

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

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

如果沒有進行更改，則返回相同的 spec。

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 操作。

檢視 unflatten() 獲取此方法的更多資訊。

unsqueeze(dim: int) → T

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

引數:

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

view(*shape) → T

重塑（reshape）一個 TensorSpec。

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

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

返回框中的零填充張量。

注意

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

引數:

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

返回:

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

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

zero() 的代理。