TensorSpec

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

张量元数据容器的父类。

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

TensorSpec 主要用于环境中，以指定其输入/输出结构，而无需执行环境（或启动它）。它们还可以用于实例化共享缓冲区，以将数据从工作进程传递到工作进程。

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

因此，TensorSpec 与 Tensor 和 TensorDict 具有一些共同的行为：它们可以被重塑形状、索引、压缩、解压缩、移动到另一个设备等。

参数:

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

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

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

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

注意

可以使用 make_composite_from_td() 函数从 TensorDict 构建 spec。此函数对可能与输入 tensordict 对应的 spec 进行低假设的推测，并且可以帮助自动构建 spec，而无需深入了解 TensorSpec API。

assert_is_in(value: Tensor) → None

断言张量是否属于该 Box，否则引发异常。

参数:

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

clear_device_() → T

对于所有叶子 spec（必须具有设备）的无操作。

对于 Composite spec，此方法将擦除设备。

abstract clone() → TensorSpec

创建 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

spec 的设备。

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

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

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

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

参数:

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

关键字参数:

ignore_device (bool, 可选) – 如果为 True，则 spec 设备将被忽略。这用于在调用 TensorDict(..., device="cuda") 中对张量转换进行分组，这会更快。

返回:

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

abstract expand(shape: Size)

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

参数:

*shape (tuple 或 int 的可迭代对象) – Spec 的新形状。必须与当前形状广播兼容：其长度必须至少与当前形状长度一样长，并且其最后的值也必须兼容；即，只有当当前维度是单例时，它们才能与它不同。

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

展平 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

为 TensorSpec 注册一个 torch 函数重写。

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 – 要索引的张量

返回:

索引张量

abstract is_in(val: torch.Tensor | tensordict.base.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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

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

注意

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

参数:

shape (torch.Size) – one-tensor 的形状

返回:

在 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。

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

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

除非 Box 是无界的，否则将在空间上均匀完成采样，在这种情况下，将绘制正态值。

参数:

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

返回:

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

reshape(shape) → T

重塑 TensorSpec。

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

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

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

有关详细信息，请参见 rand()。

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

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

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

参数:

dim (int 或 None) – 要对其应用压缩操作的维度

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

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

如果未进行任何更改，则返回相同的 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) – 布尔值，指示是否应根据 spec 的域对值执行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回:

一个 np.ndarray。

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

根据 TensorSpec dtype 检查输入值 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

代理到 zero()。