LazyStackedTensorSpec

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

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

assert_is_in(value: Tensor) → None

断言张量是否在其范围内，如果不属于则抛出异常。

参数：

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

cardinality(*args, **kwargs) → Any

规格的基数。

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

clear_device_()

清除复合对象的设备。

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) – 规格的新形状。必须与当前形状可广播：其长度必须至少与当前形状长度相同，并且其最后一个值也必须兼容；也就是说，它们只能在当前维度是单例时与当前形状不同。

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）内，则根据一些定义的启发式方法将其映射回范围内。

参数：

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 (布尔值) – 布尔值，指示是否应针对 spec 的域对值执行检查。默认使用 CHECK_SPEC_ENCODE 环境变量的值。

返回值：

一个 np.ndarray。

type_check(value: torch.Tensor, key: NestedKey | None = None) → None

检查输入值的 dtype 是否与 TensorSpec 的 dtype 匹配，如果不匹配则引发异常。

参数：

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

• key (str, 可选) – 如果 TensorSpec 包含键，则将根据指定键指向的 spec 检查值的 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

返回一个填充零的张量。

注意

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

参数：

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

返回值：

一个填充零的张量。

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

zero() 的代理。