NonTensorSpec

class torchrl.data.NonTensorSpec(*args, **kwargs)

torchrl.data.NonTensor 的已弃用版本。

assert_is_in(value: Tensor) → None

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

参数:

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

cardinality() → Any

规范的基数。

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

clear_device_() → T

所有叶子规范（必须有设备）的无操作方法。

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

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

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

参数:

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

关键字参数:

ignore_device (bool, optional) – 如果为 True，将忽略规范设备。这用于将张量类型转换分组到对 TensorDict(..., device="cuda") 的调用中，这样更快。

返回:

匹配所需张量规范的 torch.Tensor。

enumerate() → Any

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

样本将沿第一维度堆叠。

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

expand(*shape)

返回具有扩展形状的新规范。

参数:

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

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

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 属于规范域，当违反此条件时，此方法也不会引发异常。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。

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

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

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

参数:

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

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

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

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

解展平 TensorSpec。

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

unsqueeze(dim: int) → NonTensor

返回一个新的 Spec，该 Spec 增加了一个单例维度（位于 dim 指定的位置）。

参数:

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

view(*shape) → T

重塑 TensorSpec。

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

zero(shape=None)

返回一个填充零的张量。

注意

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

参数:

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

返回:

一个在 TensorSpec 范围内采样并填充了零的张量。

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

zero() 方法的代理。