無界限 (Unbounded)¶

class torchrl.data.Unbounded(*args, **kwargs)[來源]¶

一個無界限的張量規範。

Unbounded 規範永遠不會以這種形式出現，並且總是會被子類化為 UnboundedContinuous 或 UnboundedDiscrete，取決於它們的 dtype（浮點 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¶

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

參數:: 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¶

規格的裝置。

只有 Composite 規格可以有 None 裝置。所有葉節點都必須具有非空的裝置。

encode(val: numpy.ndarray | torch.Tensor | tensordict.base.TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | tensordict.base.TensorDictBase¶

根據指定的規格編碼一個值，並傳回對應的張量。

此方法用於環境中，該環境傳回一個可以輕鬆映射到 TorchRL 所需領域的值 (例如，一個 numpy 陣列)。如果該值已經是一個張量，規格將不會更改其值並按原樣傳回。

參數:: val (np.ndarray 或 torch.Tensor) – 要編碼為張量的值。
關鍵字引數：: ignore_device (bool, 可選) – 如果 True，規格裝置將被忽略。這用於在呼叫 TensorDict(..., device="cuda") 中對張量轉換進行分組，這會更快。
傳回：: 符合所需張量規格的 torch.Tensor。

expand(*shape)[原始碼]¶

傳回具有擴展形狀的新規格。

參數:: *shape (tuple 或 int 的可迭代物件) – 規格的新形狀。必須可與目前形狀廣播：其長度必須至少與目前形狀長度一樣長，並且其最後的值也必須符合；也就是說，只有在目前維度是單例的情況下，它們才能與其不同。

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¶

索引輸入張量。

參數:

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

傳回：

已索引的張量

is_in(val: Tensor) → bool[原始碼]¶

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

更精確地說，is_in 方法檢查值 val 是否在 space 屬性 (這個 box) 定義的範圍內，並且 dtype、device、shape 以及潛在的其他元數據是否與 spec 的那些匹配。如果這些檢查中的任何一個失敗，is_in 方法將返回 False。

參數:: val (torch.Tensor) – 要檢查的值。
傳回：: 布林值，指示值是否屬於 TensorSpec box。

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¶

返回 box 中一個填充 1 的張量。

注意

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

參數:: shape (torch.Size) – 填充 1 的張量的形狀
傳回：: 在 TensorSpec box 中採樣的一個填充 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 box 中，它會根據一些定義的啟發式方法將其映射回 box。

參數:: val (torch.Tensor) – 要映射到 box 的張量。
傳回：: 屬於 TensorSpec box 的 torch.Tensor。

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

回傳規格定義空間中的一個隨機張量。

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

參數:: shape (torch.Size) – 隨機張量的形狀
傳回：: 在 TensorSpec box 中採樣的隨機張量。

reshape(*shape) → T¶

重新塑造一個 TensorSpec。

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

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

回傳規格定義空間中的一個隨機張量。

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

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

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

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

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

傳回：

一個 np.ndarray。

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

檢查輸入值 dtype 是否與 TensorSpec 的 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 指示的位置）。

參數:: dim (int 或 None) – 應用 unsqueeze 操作的維度。

view(*shape) → T¶

重新塑造一個 TensorSpec。

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

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

返回盒子中一個填滿零的張量。

注意

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

參數:: shape (torch.Size) – 零張量的形狀
傳回：: 在 TensorSpec 盒子中取樣的一個填滿零的張量。

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

無界限 (Unbounded)¶

文件

Tutorials

Resources