UnboundedDiscrete

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

torchrl.data.Unbounded 的特殊版本，具有離散空間。

assert_is_in(value: Tensor) → None

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

參數:

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

clear_device_() → T

所有葉節點規格 (必須具有裝置) 的 no-op。

對於 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 spec 可以有 None 裝置。所有葉節點必須具有非空 (non-null) 的裝置。

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 的值。

關鍵字引數：

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

返回：

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

expand(*shape)

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

參數:

*shape (tuple 或 int 的可迭代物件) – 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

索引輸入 tensor。

參數:

• index (int, torch.Tensor, slice 或 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

傳回一個由 1 填充的張量，其形狀在 box 內。

注意

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

參數:

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

返回：

在 TensorSpec box 中採樣的一個由 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 box 中，它會使用一些定義好的啟發式方法將其映射回 box 中。

參數:

val (torch.Tensor) – 要映射到 box 的張量。

返回：

屬於 TensorSpec box 的 torch.Tensor。

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

傳回一個由 spec 定義的空間中的隨機張量。

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

參數:

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

返回：

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

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]) → 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 環境變數的值。

返回：

a 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

Unflattens 一個 TensorSpec。

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

unsqueeze(dim: int) → T

傳回一個新的 Spec，其中包含一個以上的單例維度（位於 dim 指示的位置）。

參數:

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) – 零張量的形狀

返回：

在 TensorSpec box 中採樣的零填充張量。

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

代理到 zero()。