UnboundedDiscreteTensorSpec

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

已棄用的 torchrl.data.Unbounded 版本，具有離散空間。

assert_is_in(value: Tensor) → None

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

參數:

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

clear_device_() → T

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

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

clone() → Unbounded

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

關鍵字參數：

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

返回值：

符合所需 tensor specs 的 torch.Tensor。

expand(*shape)

回傳具有 expanded shape 的新 Spec。

參數:

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

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

攤平（Flattens）一個 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

索引輸入 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 shape 的維度數量。

len(spec.shape) 的簡寫。

ndimension() → int

Spec shape 的維度數量。

len(spec.shape) 的簡寫。

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

返回 TensorSpec 框中填滿 1 的 tensor。

注意

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

參數:

shape (torch.Size) – 填滿 1 的 tensor 的形狀

返回值：

在 TensorSpec 框中採樣的填滿 1 的 tensor。

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

指向 one() 的 Proxy。

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

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

參數:

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

返回值：

屬於 TensorSpec 框的 torch.Tensor。

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

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

除非 box 是無界的，否則抽樣將在空間中均勻完成；在無界的情況下，將會抽取常態值。

參數:

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

返回值：

在 TensorSpec box 中抽樣的隨機張量。

reshape(*shape) → T

重新塑造 TensorSpec 的形狀。

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

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

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

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

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

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

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

參數:

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

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

將 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

根據 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，在 dim 指示的位置上增加一個 singleton 維度。

參數:

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

view(*shape) → T

重新塑造 TensorSpec 的形狀。

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

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

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

注意

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

參數:

shape (torch.Size) – 零 tensor 的形狀

返回值：

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

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

Proxy to zero().