TensorSpec

class torchrl.data.TensorSpec(shape: torch.Size, space: None | Box, device: torch.device | None = <property object>, dtype: torch.dtype = torch.float32, domain: str = "", _encode_memo_dict: dict[Any, Callable[[Any], Any]] = <factory>)

TensorSpec 的父类，用于表示张量元数据。

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) – 要检查的值。

abstract cardinality() → int

规格的基数。

这指的是规格中可能出现的结果的数量。假设复合规格的基数是所有可能结果的笛卡尔积。

clear_device_() → T

对于所有叶子规格（必须有设备），此方法无操作。

对于 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

规格的设备。

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

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

使用指定的规格对值进行编码，并返回相应的张量。

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

参数:

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

关键字参数:

ignore_device (bool, optional) – 如果为 True，将忽略 spec 设备。这用于在调用 TensorDict(..., device="cuda") 中将张量类型转换分组，这样效率更高。

返回:

符合所需张量规格的 torch.Tensor。

abstract enumerate(use_mask: bool = False) → Any

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

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

此方法仅为离散规格实现。

参数:

use_mask (bool, optional) – 如果为 True 且 spec 包含掩码，则会排除被掩码的样本。默认为 False。

erase_memoize_cache() → None

清除用于缓存 encode 执行的缓存。

另请参阅

memoize_encode().

abstract expand(shape: Size)

返回一个具有扩展形状的新 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 函数覆盖。

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

索引输入张量。

此方法用于具有一个或多个类别变量（例如，OneHot 或 Categorical）的 spec，这样在用样本索引张量时，就不需要关心实际的索引表示。

参数:

• 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)

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 区域。

make_neg_dim(dim: int) → T

将特定维度转换为 -1。

memoize_encode(mode: bool = True) → None

创建 encode 方法的缓存可调用序列，以加快其执行速度。

这应该只在输入类型、形状等在给定规格的调用之间预期一致时使用。

参数:

mode (bool, optional) – 是否使用缓存。默认为 True。

另请参阅

可以通过 erase_memoize_cache() 来擦除缓存。

property ndim: int

规格形状的维数。

相当于 len(spec.shape)。

ndimension() → int

规格形状的维数。

相当于 len(spec.shape)。

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

返回盒中的一个填充一的张量。

注意

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

参数:

shape (torch.Size) – 一维张量的形状

返回:

在 TensorSpec 区域中采样的填充一的张量。

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

指向 one() 的代理。

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

如果输入张量不在 TensorSpec 区域内，则根据定义的启发式方法将其映射回该区域。

参数:

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

返回:

属于 TensorSpec 区域的 torch.Tensor。

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

返回规格定义的区域中的随机张量。

采样将在区域内均匀进行，除非区域无界，在这种情况下将绘制正态值。

参数:

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

返回:

在 TensorSpec 区域中采样的随机张量。

reshape(shape) → T

重塑一个 TensorSpec。

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

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

返回规格定义的区域中的随机张量。

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

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

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

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

参数:

dim (int 或 None) – 应用挤压操作的维度

abstract to(dest: torch.dtype | DEVICE_TYPING) → TensorSpec

将 TensorSpec 转换为设备或 dtype。

如果未进行更改，则返回相同的规格。

to_numpy(val: torch.Tensor | TensorDictBase, safe: bool | None = None) → np.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

检查输入值 dtype 是否与 TensorSpec dtype 匹配，如果不匹配则引发异常。

参数:

• value (torch.Tensor) – 必须检查其 dtype 的张量。

• key (str, optional) – 如果 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 属于 spec 域，但此方法在违反此条件时不会引发异常。 zero 的主要用例是生成空数据缓冲区，而不是有意义的数据。

参数:

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

返回:

在 TensorSpec 框中采样的零填充张量。

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

代理到 zero()。