Stacked

class torchrl.data.Stacked(*specs: Tuple[T, ...], dim: int)

栈张量规格的惰性表示。

沿一个维度将张量规格堆叠在一起。当抽取随机样本时，如果可能，将返回一个样本栈。否则，将抛出错误。

允许索引，但只能沿堆叠维度进行。

此类旨在用于多任务和多智能体设置，其中可能出现异构规格（语义相同但形状不同）。

assert_is_in(value: Tensor) → None

断言张量是否属于指定的范围，否则抛出异常。

参数：

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

cardinality(*args, **kwargs) → Any

规格的基数。

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

clear_device_()

清除 Composite 的设备设置。

clone() → T

创建 TensorSpec 的副本。

contains(item: torch.Tensor | TensorDictBase) → bool

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

有关更多信息，请参阅 is_in()。

cpu()

将 TensorSpec 转换到 ‘cpu’ 设备。

cuda(device=None)

将 TensorSpec 转换到 ‘cuda’ 设备。

property device: Union[device, str, int]

规格的设备。

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

encode(val: Union[ndarray, Tensor], *, ignore_device=False) → Tensor

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

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

参数：

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

关键字参数：

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

返回：

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

enumerate() → torch.Tensor | TensorDictBase

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

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

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

expand(*shape)

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

参数：

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

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(value) → bool

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

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

参数：

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

返回：

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

make_neg_dim(dim: int)

将特定维度转换为 -1。

property ndim

规格形状的维度数量。

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

ndimension()

规格形状的维度数量。

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

one(shape: Optional[Size] = None) → TensorDictBase

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

注意

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

参数：

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

返回：

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

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

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

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

参数：

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

返回：

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

reshape(*shape) → T

重塑 TensorSpec。

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

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

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

详情请参阅 rand()。

squeeze(dim: Optional[int] = None)

返回移除所有大小为 1 的维度的新规格。

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

参数：

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

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

将 TensorSpec 转换到设备或 dtype。

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

to_numpy(val: Tensor, safe: Optional[bool] = None) → dict

返回输入张量对应的 np.ndarray。

这旨在成为 encode() 的逆操作。

参数：

• val (torch.Tensor) – 要转换为 numpy 的张量。

• safe (bool, optional) – 布尔值，指示是否应针对规格域对值执行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回：

一个 np.ndarray。

type_check(value: torch.Tensor, key: NestedKey | None = 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)

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

参数：

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

view(*shape) → T

重塑 TensorSpec。

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

zero(shape: Optional[Size] = None) → TensorDictBase

返回一个填充了零的张量（在 box 中）。

注意

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

参数：

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

返回：

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

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

zero() 的代理。