NonTensor

class torchrl.data.NonTensor(shape: Union[Size, int] = torch.Size([1]), device: Optional[Union[device, str, int]] = None, dtype: Optional[dtype] = None, **kwargs)

非張量資料的規格。

此規格具有像 NonTensorData 一樣的 shae、device 和 dtype。

rand() 將傳回一個具有 None 資料值的 NonTensorData 物件。（zero() 和 one() 也是如此）。

assert_is_in(value: Tensor) → None

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

參數:

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

clear_device_() → T

所有葉節點規格（必須具有 device）的 no-op 操作。

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

clone() → NonTensor

建立 TensorSpec 的副本。

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

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

參閱 is_in() 以取得更多資訊。

cpu()

將 TensorSpec 轉換為 'cpu' device。

cuda(device=None)

將 TensorSpec 轉換為 'cuda' device。

property device: device

規格的 device。

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

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

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

此方法用於環境傳回一個值（例如，一個 numpy 陣列）可以容易地映射到 TorchRL 所需的網域。如果該值已經是一個 tensor，該規格將不會更改其值並按原樣傳回。

參數:

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

關鍵字引數：

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

傳回：

符合所需 tensor 規格的 torch.Tensor。

expand(*shape)

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

參數:

*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 – 要建立索引的張量

傳回：

已建立索引的張量

is_in(val: Tensor) → bool

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

更精確地說，is_in 方法會檢查值 val 是否在 space 屬性（方框）定義的限制內，以及 dtype、device、shape 和潛在的其他中繼資料是否與規格的中繼資料相符。如果任何這些檢查失敗，is_in 方法將傳回 False。

參數:

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

傳回：

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

make_neg_dim(dim: int) → T

將特定維度轉換為 -1。

property ndim: int

規格形狀的維度數量。

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

ndimension() → int

規格形狀的維度數量。

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

one(shape=None)

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

注意

即使無法保證 1 屬於規格網域，但如果違反此條件，此方法也不會引發例外。 one 的主要用途是產生空的資料緩衝區，而不是有意義的資料。

參數:

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

傳回：

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

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

Proxy to one().

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

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

參數:

val (torch.Tensor) – 要對應到方框的張量。

傳回：

屬於 TensorSpec 方框的 torch.Tensor。

rand(shape=None)

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

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

參數:

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

傳回：

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

reshape(*shape) → T

重新調整 TensorSpec 的形狀。

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

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

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

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

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

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

當給定 dim 時，擠壓操作僅在該維度中進行。

參數:

dim (int 或 None) – 要對其應用擠壓操作的維度

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

將 TensorSpec 轉換為裝置或 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

根據 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) → T

回傳一個新的 Spec，其維度會多一個 singleton 維度（在 dim 指定的位置）。

參數:

dim (int or None) – 執行 unsqueeze 操作的維度。

view(*shape) → T

重新調整 TensorSpec 的形狀。

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

zero(shape=None)

回傳一個在 box 中填滿零的 tensor。

注意

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

參數:

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

傳回：

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

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

等同於 zero()。