NonTensorSpec

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

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

assert_is_in(value: Tensor) → None

斷言張量是否屬於該 box，否則引發例外。

參數:

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

clear_device_() → T

適用於所有葉子規格 (必須具有裝置) 的空操作。

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

clone() → NonTensor

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

Spec 的裝置。

只有 Composite spec 可以擁有 None 裝置。所有葉節點必須有一個非空的裝置。

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

根據指定的 spec 編碼一個數值，並回傳對應的 tensor。

這個方法用於回傳數值的環境（例如 numpy 陣列），這些數值可以輕鬆地映射到 TorchRL 所需的域。如果該數值已經是一個 tensor，spec 將不會變更其數值並直接回傳它。

參數:

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

關鍵字參數:

ignore_device (bool, optional) – 如果 True，將忽略 spec 裝置。這用於在呼叫 TensorDict(..., device="cuda") 時對 tensor 轉換進行分組，這樣可以更快。

回傳:

符合所需 tensor spec 的 torch.Tensor。

expand(*shape)

回傳一個具有擴展形狀的新 Spec。

參數:

*shape (tuple or iterable of int) – Spec 的新形狀。必須與目前的形狀可廣播：其長度必須至少與目前形狀的長度一樣長，並且其最後的值也必須相容；也就是說，只有在目前的維度是單例的情況下，它們才能與之不同。

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

展平一個 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

為 TensorSpec 註冊一個 torch function 覆寫。

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

為輸入的 tensor 建立索引。

參數:

• index (int, torch.Tensor, slice or list) – tensor 的索引

• tensor_to_index – 要建立索引的 tensor

回傳:

已建立索引的 tensor

is_in(val: Tensor) → 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=None)

返回邊界框內的一個全 1 張量。

注意

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

參數:

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

回傳:

在 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=None)

返回 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) → T

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

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

參數:

dim (int 或 None) – 要套用 squeeze 操作的維度

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

將 TensorSpec 轉換為 device 或 dtype。

如果沒有進行任何變更，則傳回相同的 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

重塑 TensorSpec。

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

zero(shape=None)

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

注意

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

參數:

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

回傳:

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

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

等同於 zero()。