UnboundedDiscreteTensorSpec

类 torchrl.data.UnboundedDiscreteTensorSpec(*args, **kwargs)

torchrl.data.Unbounded 的已弃用版本，用于离散空间。

assert_is_in(value: Tensor) → None

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

参数:

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

cardinality() → int

Spec 的基数。

这是指一个 spec 中可能结果的数量。假设组合 spec 的基数是所有可能结果的笛卡尔积。

clear_device_() → T

对于所有叶子 spec（必须具有设备信息）而言，这是一个空操作。

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

clone() → Unbounded

创建 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。所有叶子都必须具有非空设备。

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

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

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

参数:

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

关键字参数:

ignore_device (bool, 可选) – 如果为 True，将忽略 spec 的设备信息。这用于在调用 TensorDict(..., device="cuda") 中将张量类型转换分组，从而更快。

返回:

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

enumerate() → Any

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

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

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

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 注册一个 PyTorch 函数重载。

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

对输入张量进行索引。

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

参数:

• index (int, torch.Tensor, 切片 或 列表) – 张量的索引

• 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: Tensor) → 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

返回一个范围内的全一张量。

注意

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

参数:

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

返回:

在 TensorSpec 范围 box 中采样得到的一个全一张量。

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

one() 的代理。

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

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

参数:

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

返回:

属于 TensorSpec 范围 box 的一个 torch.Tensor。

rand(shape: Optional[Size] = None) → Tensor

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

采样将均匀分布在空间上，除非范围 box 是无界的，在这种情况下将抽取正态分布的值。

参数:

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

返回:

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

reshape(*shape) → T

重塑 TensorSpec。

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

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

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

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

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

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

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

参数:

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

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

将 TensorSpec 转换为指定的设备或 dtype。

如果没有发生更改，则返回相同的 spec。

to_numpy(val: torch.Tensor | TensorDictBase, safe: bool = 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 匹配，如果不匹配则引发异常。

参数:

• 值 (torch.Tensor) – 需要检查其 dtype 的张量。

• 键 (str, optional) – 如果 TensorSpec 有键，则将根据指定键指向的 spec 来检查值的 dtype。

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

将一个 TensorSpec 取消展平。

查看 unflatten() 了解此方法的更多信息。

unsqueeze(dim: int) → T

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

参数:

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

view(*shape) → T

重塑 TensorSpec。

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

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

返回 spec 框内的零填充张量。

注意

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

参数:

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

返回:

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

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

是 zero() 的代理。