无界¶

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() 的代理。

无界¶

文档

教程

资源