TensorSpec

class torchrl.data.TensorSpec(shape: torch.Size, space: Union[None, Box], device: torch.device | None = <property object>, dtype: torch.dtype = torch.float32, domain: str = '')

张量元数据容器的父类。

TorchRL 的 TensorSpec 用于表示特定类别的预期输入/输出，有时也用于通过在定义的空间内生成随机数据来模拟简单的行为。

TensorSpecs 主要用于环境中，以便在无需执行环境（或启动环境）的情况下指定其输入/输出结构。它们也可用于实例化共享缓冲区，以便在工作进程之间传递数据。

TensorSpecs 是数据类，始终共享以下字段：shape、space、dtype 和 device。

因此，TensorSpecs 与 Tensor 和 TensorDict 具有一些共同的行为：它们可以被重塑（reshape）、索引（index）、压缩（squeeze）、解压缩（unsqueeze）、移动到另一个设备等。

参数:

• shape (torch.Size) – 张量的大小。形状包括批量维度和特征维度。负数形状（-1）表示该维度具有可变数量的元素。

• space (Box) – 描述预期值类型的 Box 实例。

• device (torch.device) – 张量的设备。

• dtype (torch.dtype) – 张量的数据类型。

注意

可以使用 make_composite_from_td() 函数从 TensorDict 构建一个 spec。此函数会根据输入的 tensordict 进行低假设的有根据的猜测，以构建可能对应的 spec，并可帮助在无需深入了解 TensorSpec API 的情况下自动构建 spec。

assert_is_in(value: Tensor) → None

断言张量是否属于 Box，否则抛出异常。

参数:

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

abstract cardinality() → int

spec 的基数（cardinality）。

这指的是 spec 中可能结果的数量。复合 spec 的基数假定为所有可能结果的笛卡尔积。

clear_device_() → T

对所有叶子 spec（必须有设备）来说是空操作（no-op）。

对于 Composite spec，此方法将抹去设备信息。

abstract clone() → TensorSpec

创建 TensorSpec 的副本。

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

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

有关更多信息，请参阅 is_in()。

cpu()

将 TensorSpec 转换为 ‘cpu’ 设备。

cuda(device=None)

将 TensorSpec 转换为 ‘cuda’ 设备。

property device: device

spec 的设备。

只有 Composite spec 可以有 None 设备。所有叶子 spec 都必须有非空设备。

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

根据指定的 spec 对值进行编码，并返回相应的张量。

此方法用于返回可轻松映射到 TorchRL 所需域的值（例如 numpy 数组）的环境。如果值已经是张量，则 spec 不会更改其值并按原样返回。

参数:

val (np.ndarray or torch.Tensor) – 要编码为张量的值。

关键字参数:

ignore_device (bool, optional) – 如果为 True，将忽略 spec 设备。这用于在调用 TensorDict(..., device="cuda") 中进行张量转换，这样速度更快。

返回:

与所需张量 spec 匹配的 torch.Tensor。

abstract enumerate() → Any

返回可以从 TensorSpec 获取的所有样本。

样本将沿第一个维度堆叠。

此方法仅针对离散 spec 实现。

abstract expand(shape: Size)

返回具有扩展形状的新 Spec。

参数:

*shape (tuple or iterable of int) – Spec 的新形状。必须与当前形状可广播（broadcastable）：其长度必须至少与当前形状长度相同，并且其最后一个值也必须兼容；即，仅当当前维度是单例（singleton）时，它们才能与当前形状不同。

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

展平（flatten）一个 TensorSpec。

有关此方法的更多信息，请查阅 flatten()。

classmethod implements_for_spec(torch_function: Callable) → Callable

为 TensorSpec 注册一个 torch 函数覆盖。

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

索引输入张量。

此方法用于编码一个或多个分类变量（例如 OneHot 或 Categorical）的 spec，以便可以使用样本对张量进行索引，而无需关心索引的实际表示。

参数:

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

abstract is_in(val: torch.Tensor | TensorDictBase) → 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 形状的维度数。

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

ndimension() → int

spec 形状的维度数。

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

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

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

注意

即使不能保证 1 属于 spec 域，当违反此条件时，此方法也不会抛出异常。one 的主要用例是生成空的数据缓冲区，而不是有意义的数据。

参数:

shape (torch.Size) – 填充 1 的张量的形状

返回:

在 TensorSpec Box 中采样的一个填充 1 的张量。

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

是 one() 的代理（Proxy）。

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

如果输入张量不在 TensorSpec Box 中，则根据某些定义的启发式将其映射回 Box 中。

参数:

val (torch.Tensor) – 要映射到 Box 的张量。

返回:

属于 TensorSpec Box 的 torch.Tensor。

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

返回由 spec 定义空间中的随机张量。

采样将在空间中均匀进行，除非 Box 无界，在这种情况下将抽取正态值。

参数:

shape (torch.Size) – 随机张量的形状

返回:

在 TensorSpec Box 中采样的随机张量。

reshape(shape) → T

重塑（reshape）一个 TensorSpec。

有关此方法的更多信息，请查阅 reshape()。

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

返回由 spec 定义空间中的随机张量。

详细信息请参见 rand()。

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

返回一个新 Spec，其中所有大小为 1 的维度均已移除。

给定 dim 时，仅在该维度上执行压缩操作。

参数:

dim (int or None) – 应用压缩操作的维度

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

将 TensorSpec 转换为设备或数据类型。

如果没有进行更改，则返回相同的 spec。

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, optional) – 如果 TensorSpec 具有键，则将根据指定键指向的规范检查值的 dtype。

unflatten(dim: int, sizes: Tuple[int]) → T

对 TensorSpec 进行 unflatten 操作。

查看 unflatten() 获取此方法的更多信息。

unsqueeze(dim: int) → T

返回一个新的 Spec，其中包含一个额外的单维度（位于由 dim 指定的位置）。

参数:

dim (int or None) – 应用 unsqueeze 操作的维度。

view(*shape) → T

重塑（reshape）一个 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() 的代理。