BoundedTensorSpec

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

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

assert_is_in(value: Tensor) → None

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

参数:

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

cardinality() → int

规格的基数。

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

clear_device_() → T

对所有叶子规格而言，这是一个无操作 (no-op)（它们必须有一个设备）。

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

clone() → Bounded

创建 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 或 torch.Tensor) – 要编码为张量的值。

关键字参数:

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

返回值:

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

enumerate() → Any

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

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

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

expand(*shape)

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

参数:

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

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: Tensor) → 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: torch.Size = None) → torch.Tensor | TensorDictBase

返回范围内的全一张量。

注意

即使不保证 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: Optional[Size] = None) → Tensor

返回由规格定义的空间中的随机张量。

采样将在空间内均匀进行，除非范围是无界的，在这种情况下将绘制正态值。

参数:

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

返回值:

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

reshape(*shape) → T

重塑一个 TensorSpec。

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

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

返回由规格定义的空间中的随机张量。

详细信息请参阅 rand()。

squeeze(dim: int | None = None)

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

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

参数:

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

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

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

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

解除展平 TensorSpec。

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

unsqueeze(dim: int)

返回一个新的 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() 的代理。