BoundedTensorSpec

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

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

assert_is_in(value: Tensor) → None

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

參數:

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

clear_device_() → T

所有葉子規格 (必須具有裝置) 的無操作。

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

clone() → Bounded

建立 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 specs 可以有 None 裝置。所有 leaves 必須有一個非空的裝置。

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 或 torch.Tensor) – 要編碼為 tensor 的值。

Keyword Arguments:

ignore_device (bool, optional) – 如果 True，則 spec 裝置將被忽略。這用於將 tensor 轉換分組到 TensorDict(..., device="cuda") 的呼叫中，這樣會更快。

Returns:

與所需 tensor specs 相符的 torch.Tensor。

expand(*shape)

返回具有擴展形狀的新 Spec。

參數:

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

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

展平 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

為 TensorSpec 註冊一個 torch function override。

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 或 list) – 張量的索引

• tensor_to_index – 要進行索引的張量

Returns:

已索引的張量

is_in(val: Tensor) → bool

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

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

參數:

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

Returns:

布林值，指示值是否屬於 TensorSpec 邊界框。

make_neg_dim(dim: int) → T

將特定維度轉換為 -1。

property ndim: int

spec shape 的維度數量。

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

ndimension() → int

spec shape 的維度數量。

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

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

傳回邊界框內填充 1 的張量。

注意

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

參數:

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

Returns:

在 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) – 要映射到邊界框的張量。

Returns:

屬於 TensorSpec 邊界框的 torch.Tensor。

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

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

除非該空間的邊界未定義，否則採樣將在空間中均勻完成，在未定義邊界的情況下，將抽取常態值。

參數:

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

Returns:

在 TensorSpec 邊界框中採樣的隨機張量。

reshape(*shape) → T

重新塑造一個 TensorSpec。

請查看 reshape() 以取得更多關於此方法的信息。

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

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

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

squeeze(dim: Optional[int] = None)

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

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

參數:

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

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

將 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) – 布林值，指示是否應根據規格的域對該值執行檢查。預設為 CHECK_SPEC_ENCODE 環境變數的值。

Returns:

一個 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)。

請查看 unflatten() 以取得更多關於此方法的信息。

unsqueeze(dim: int)

回傳一個新的 Spec，其中在 dim 指示的位置增加一個單例維度 (singleton dimension)。

參數:

dim (int 或 None) – 套用 unsqueeze 操作的維度。

view(*shape) → T

重新塑造一個 TensorSpec。

請查看 reshape() 以取得更多關於此方法的信息。

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

回傳一個在邊界框 (box) 內的填滿零的張量。

注意

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

參數:

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

Returns:

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

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

Proxy to zero().