NonTensor

class torchrl.data.NonTensor(shape: Union[torch.Size, int] = torch.Size([1]), device: Optional[DEVICE_TYPING] = None, dtype: torch.dtype | None = None, example_data: Any = None, **kwargs)

非张量数据的规格。

此规格具有形状、设备和数据类型，类似于 NonTensorData。

rand() 将返回一个数据值为 None 的 NonTensorData 对象。（zero() 和 one() 也一样。）

注意

NonTensor 的默认形状是 (1,)。

assert_is_in(value: Tensor) → None

断言张量是否属于该范围（box），否则引发异常。

参数：

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

cardinality() → Any

规格的基数。

这指的是规格中可能结果的数量。复合规格的基数被认为是所有可能结果的笛卡尔积。

clear_device_() → T

对于所有叶子规格（必须有设备），此操作不执行任何动作（no-op）。

对于 Composite 规格，此方法将清除设备。

clone() → NonTensor

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

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

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

参数：

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

关键字参数：

ignore_device (bool, 可选) – 如果为 True，则忽略规格设备。这用于在调用 TensorDict(..., device="cuda") 时将张量转换分组，从而提高速度。

返回值：

与所需张量规格匹配的 torch.Tensor 或 TensorDictBase。

enumerate() → Any

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

样本将沿第一维堆叠。

此方法仅针对离散规格实现。

expand(*shape)

返回具有扩展形状的新 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 函数重写。

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: Any) → bool

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

更准确地说，is_in 方法检查值 val 是否在由 space 属性（即范围）定义的限制内，并且 dtype、device、shape> 以及可能的其他元数据是否与规格匹配。如果其中任何检查失败，is_in 方法将返回 False。

参数：

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

返回值：

一个布尔值，指示值是否属于 TensorSpec 的范围。

make_neg_dim(dim: int) → T

将特定维度转换为 -1。

property ndim: int

规格形状的维度数量。

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

ndimension() → int

规格形状的维度数量。

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

one(shape=None)

返回范围内一个填充为 1 的张量。

注意

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

参数：

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

返回值：

在 TensorSpec 范围内采样的填充为 1 的张量。

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

one() 的代理。

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

如果输入张量不在 TensorSpec 范围内，它会根据定义的启发式方法将其映射回范围内。

参数：

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

返回值：

属于 TensorSpec 范围的 torch.Tensor。

rand(shape=None)

在规格定义的空间中返回一个随机张量。

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

参数：

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

返回值：

在 TensorSpec 范围内采样的随机张量。

reshape(*shape) → T

重塑 TensorSpec 的形状。

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

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

在规格定义的空间中返回一个随机张量。

详细信息请参见 rand()。

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

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

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

参数：

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

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

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

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

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) → NonTensor

返回一个新增了一个单例维度（在由 dim 指定的位置）的新 Spec。

参数：

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

view(*shape) → T

重塑 TensorSpec 的形状。

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

zero(shape=None)

在指定的框中返回一个用零填充的张量。

注意

即使无法保证 0 属于规范域，此方法在违反此条件时也不会引发异常。`zero` 的主要用例是生成空数据缓冲区，而不是有意义的数据。

参数：

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

返回值：

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

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

zero() 的代理。