UnboundedContinuous

類 torchrl.data.UnboundedContinuous(*args, **kwargs)

它是 torchrl.data.Unbounded 的一個特殊版本，具有連續空間。

assert_is_in(value: Tensor) → None

斷言張量是否屬於該範圍框，否則丟擲異常。

引數:

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

cardinality() → int

該規範的基數。

這指的是規範中可能結果的數量。假定複合規範的基數是所有可能結果的笛卡爾積。

clear_device_() → T

對於所有葉子規範（必須具有裝置），此操作為空操作（no-op）。

對於 Composite 規範，此方法將擦除裝置資訊。

clone() → Unbounded

建立 TensorSpec 的副本。

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

如果值 val 可以由 TensorSpec 生成，則返回 True，否則返回 False。

更多資訊請參閱 is_in()。

cpu()

將 TensorSpec 轉換為 ‘cpu’ 裝置。

cuda(device=None)

將 TensorSpec 轉換為 ‘cuda’ 裝置。

屬性 device: device

該規範的裝置。

只有 Composite 規範可以有 None 裝置。所有葉子必須具有非空裝置。

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

根據指定的規範對值進行編碼，並返回相應的張量。

此方法用於返回可輕鬆對映到 TorchRL 所需域的值（例如 numpy 陣列）的環境。如果值已是張量，則規範不會改變其值，而是按原樣返回。

引數:

val (np.ndarray 或 torch.Tensor) – 待編碼為張量的值。

關鍵字引數:

ignore_device (bool, optional) – 如果為 True，則將忽略規範的裝置。這用於將張量型別轉換分組到 TensorDict(..., device="cuda") 呼叫中，這樣更快。

返回:

與所需張量規範匹配的 torch.Tensor。

enumerate() → Any

返回可以從 TensorSpec 獲取的所有樣本。

樣本將沿第一維堆疊。

此方法僅針對離散規範實現。

expand(*shape)

返回具有擴充套件形狀的新規範。

引數:

*shape (tuple 或 iterable of int) – 規範的新形狀。必須與當前形狀可廣播：其長度必須至少與當前形狀長度相同，並且其最後一個值也必須相容；即只有當前維度為單例時，它們才能與當前形狀不同。

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

展平一個 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

為 TensorSpec 註冊一個 torch 函式過載。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase

對輸入張量進行索引。

此方法用於對一個或多個分類變數進行編碼的規範（例如 OneHot 或 Categorical），這樣就可以在不關心索引的實際表示的情況下對張量進行索引。

引數:

• index (int, torch.Tensor, slice 或 list) – 張量的索引

• tensor_to_index – 待索引的張量

返回:

索引後的張量

示例

>>> from torchrl.data import OneHot
>>> import torch
>>>
>>> one_hot = OneHot(n=100)
>>> categ = one_hot.to_categorical_spec()
>>> idx_one_hot = torch.zeros((100,), dtype=torch.bool)
>>> idx_one_hot[50] = 1
>>> print(one_hot.index(idx_one_hot, torch.arange(100)))
tensor(50)
>>> idx_categ = one_hot.to_categorical(idx_one_hot)
>>> print(categ.index(idx_categ, torch.arange(100)))
tensor(50)

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。

屬性 ndim: int

規範形狀的維度數量。

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

ndimension() → int

規範形狀的維度數量。

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

one(shape: torch.Size = None) → torch.Tensor | TensorDictBase

返回範圍內一個填充為 1 的張量。

注意

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

引數:

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

返回:

在 TensorSpec 範圍內取樣的一個填充為 1 的張量。

ones(shape: torch.Size = None) → torch.Tensor | TensorDictBase

one() 的代理。

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

如果輸入張量不在 TensorSpec 範圍內，它將根據某些定義的啟發式方法將其映射回範圍內。

引數:

val (torch.Tensor) – 待對映到範圍框的張量。

返回:

屬於 TensorSpec 範圍框的 torch.Tensor。

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

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

取樣將在空間中均勻進行，除非該範圍框無界，此時將抽取正態分佈的值。

引數:

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

返回:

在 TensorSpec 範圍內取樣的隨機張量。

reshape(*shape) → T

重塑一個 TensorSpec。

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

sample(shape: torch.Size = None) → torch.Tensor | TensorDictBase

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

詳情請參閱 rand()。

squeeze(dim: int | None = None) → T

返回一個新規範，並移除所有大小為 1 的維度。

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

引數:

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

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

將 TensorSpec 轉換為裝置或資料型別。

如果未進行更改，則返回相同的規範。

to_numpy(val: torch.Tensor | TensorDictBase, safe: bool = None) → np.ndarray | dict

返回輸入張量的 np.ndarray 對應項。

這旨在作為 encode() 的逆操作。

引數:

• val (torch.Tensor) – 待轉換為 numpy 的張量。

• safe (bool) – 布林值，指示是否應對值進行檢查以對抗規範域。預設為 CHECK_SPEC_ENCODE 環境變數的值。

返回:

一個 np.ndarray。

type_check(value: Tensor, key: Optional[NestedKey] = None) → None

檢查輸入值 dtype 與 TensorSpec dtype 是否匹配，如果不匹配則引發異常。

引數:

• value (torch.Tensor) – 待檢查資料型別的張量。

• key (str, optional) – 如果 TensorSpec 有鍵，則將根據指示的鍵指向的規範檢查值的資料型別。

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: torch.Size = None) → torch.Tensor | TensorDictBase

返回一個根據此 Spec 填充零的張量。

注意

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

引數:

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

返回:

一個根據 TensorSpec 填充零的張量。

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase

zero() 的別名。