無界¶

class torchrl.data.Unbounded(*args, **kwargs)[原始碼]¶

一個無界張量規範。

Unbounded 規範不會直接出現，而是根據其 dtype 總是被子類化為 UnboundedContinuous 或 UnboundedDiscrete（浮點 dtype 會生成 UnboundedContinuous 例項，所有其他 dtype 會生成 UnboundedDiscrete 例項）。

雖然它沒有明確的上下限，但此類仍然擁有一個 Box 空間，該空間編碼了 dtype 可接受的最大值和最小值。

引數：

shape (torch.Size) – Bounded 規範的形狀。形狀必須指定。輸入 low、high 和 shape 必須可廣播。
device (str, int 或 torch.device, 可選) – 張量的裝置。
dtype (str 或 torch.dtype, 可選) – 張量的 dtype。
domain (str) – “continuous” 或 “discrete”。可用於覆蓋自動型別分配。

示例

>>> spec = Unbounded(shape=(), dtype=torch.float)
>>> spec
UnboundedContinuous(
    shape=torch.Size([]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)
>>> spec = Unbounded(shape=(), dtype=torch.int)
>>> spec
UnboundedDiscrete(
    shape=torch.Size([]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int32, contiguous=True)),
    device=cpu,
    dtype=torch.int32,
    domain=discrete)
>>> spec.to(torch.float)
UnboundedContinuous(
    shape=torch.Size([]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)
>>> spec = Unbounded(shape=(), dtype=torch.int, domain="continuous")
>>> spec
UnboundedContinuous(
    shape=torch.Size([]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int32, contiguous=True)),
    device=cpu,
    dtype=torch.int32,
    domain=continuous)

assert_is_in(value: Tensor) → None¶

斷言張量是否屬於該 Box 空間，否則引發異常。

引數：: 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' 裝置。

property 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, 可選) – 如果為 True，則忽略規範裝置。這用於在呼叫 TensorDict(..., device="cuda") 時將張量轉換分組，這樣更快。
返回值：: 匹配所需張量規範的 torch.Tensor。

enumerate() → Any[原始碼]¶

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

樣本將沿第一個維度堆疊。

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

expand(*shape)[原始碼]¶

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

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

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 屬性（Box）定義的限制內，並且檢查 dtype、device、shape 以及可能的其他元資料是否與規範的匹配。如果任何這些檢查失敗，is_in 方法將返回 False。

引數：: val (torch.Tensor) – 要檢查的值。
返回值：: 一個布林值，指示值是否屬於 TensorSpec 的 Box。

make_neg_dim(dim: int) → T¶: 將特定維度轉換為 -1。

property ndim: int¶

規範形狀的維度數量。

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

ndimension() → int¶

規範形狀的維度數量。

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

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

返回 Box 中填充了 1 的張量。

注意

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

引數：: shape (torch.Size) – 全一張量的形狀
返回值：: 在 TensorSpec Box 中取樣的全一張量。

ones(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: one() 的代理方法。

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

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

引數：: val (torch.Tensor) – 要對映到 Box 的張量。
返回值：: 屬於 TensorSpec Box 的 torch.Tensor。

rand(shape: Optional[Size] = None) → Tensor[原始碼]¶

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

除非 Box 是無界的，否則將在空間上均勻取樣；如果 Box 無界，則將抽取正態分佈的值。

引數：: shape (torch.Size) – 隨機張量的形狀
返回值：: 在 TensorSpec Box 中取樣的隨機張量。

reshape(*shape) → T¶

重塑 TensorSpec。

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

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

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

詳細資訊請參見 rand()。

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

返回一個移除了所有大小為 1 的維度的新 Spec。

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

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

to(dest: Union[dtype, device, str, int]) → Unbounded[原始碼]¶

將 TensorSpec 轉換到裝置或 dtype。

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

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) – 需要檢查 dtype 的張量。
key (str, 可選) – 如果 TensorSpec 包含鍵，則將根據指定鍵指向的規範檢查值的 dtype。

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¶

返回在此規範域中的零填充張量。

注意

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

引數：: shape (torch.Size) – 零張量的形狀。
返回值：: 一個在 TensorSpec 規範域中取樣的零填充張量。

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: zero() 的代理。

無界¶

文件

教程

資源