LazyStackedCompositeSpec

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

torchrl.data.StackedComposite 已废弃的版本。

assert_is_in(value: Tensor) → None

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

参数：

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

cardinality(*args, **kwargs) → Any

规范（spec）的基数。

这指的是一个规范中可能结果的数量。假定复合规范（composite spec）的基数是所有可能结果的笛卡尔积。

clear_device_()

清除 Composite 的设备设置。

clone() → T

克隆 Composite 规范。

锁定的规范不会产生锁定的克隆。

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 设备。所有叶节点必须拥有非空设备。

empty()

创建一个与自身类似但没有条目的规范。

encode(vals: Dict[str, Any], ignore_device: bool = False) → Dict[str, Tensor]

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

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

参数：

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

关键字参数：

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

返回值：

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

enumerate() → TensorDictBase

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

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

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

expand(*shape)

返回一个具有扩展形状的新 Spec。

参数：

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

flatten(start_dim: int, end_dim: int) → T

展平（flatten）一个 TensorSpec。

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

get(item, default=_NoDefault.ZERO)

从 Composite 中获取一个项目。

如果项目不存在，可以传递一个默认值。

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_empty(recurse: bool | None =None)

复合规范是否包含子规范。

参数：

recurse (bool) – 是否递归评估规范是否为空。如果为 True，则在没有叶节点时返回 True。如果为 False（默认），则返回根级别是否定义了任何规范。

is_in(value) → bool

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

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

参数：

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

返回值：

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

items(include_nested: bool = False, leaves_only: bool = False, *, is_leaf: Callable[[type], bool] | None =None) → _CompositeSpecItemsView

Composite 的项目。

参数：

• include_nested (bool, 可选) – 如果为 False，则返回的键不会嵌套。它们将仅表示根的直接子项，而不是整个嵌套序列，例如 Composite(next=Composite(obs=None)) 将导致键为 ["next"]. 默认值为 False，即不会返回嵌套键。

• leaves_only (bool, 可选) – 如果为 False，则返回的值将包含所有级别的嵌套，例如 Composite(next=Composite(obs=None)) 将导致键为 ["next", ("next", "obs")]。默认值为 False。

关键字参数：

is_leaf (callable, 可选) – 读取一个类型并返回一个布尔值，指示该类型是否应被视为叶节点。默认情况下，所有非 Composite 节点都被视为叶节点。

keys(include_nested: bool = False, leaves_only: bool = False, *, is_leaf: Callable[[type], bool] | None =None) → _CompositeSpecKeysView

Composite 的键。

keys 参数反映了 tensordict.TensorDict 的参数。

参数：

• include_nested (bool, 可选) – 如果为 False，则返回的键不会嵌套。它们将仅表示根的直接子项，而不是整个嵌套序列，例如 Composite(next=Composite(obs=None)) 将导致键为 ["next"]. 默认值为 False，即不会返回嵌套键。

• leaves_only (bool, 可选) – 如果为 False，则返回的值将包含所有级别的嵌套，例如 Composite(next=Composite(obs=None)) 将导致键为 ["next", ("next", "obs")]。默认值为 False。

关键字参数：

is_leaf (callable, 可选) – 读取一个类型并返回一个布尔值，指示该类型是否应被视为叶节点。默认情况下，所有非 Composite 节点都被视为叶节点。

lock_(recurse: bool | None =None) → T

锁定 Composite 并阻止对其内容的修改。

recurse 参数控制锁定是否传播到子规范。当前默认值为 False，但在 v0.8 版本中将更改为 True，以与 TensorDict API 保持一致。

示例

>>> shape = [3, 4, 5]
>>> spec = Composite(
...         a=Composite(
...         b=Composite(shape=shape[:3], device="cpu"), shape=shape[:2]
...     ),
...     shape=shape[:1],
... )
>>> spec["a"] = spec["a"].clone()
>>> recurse = False
>>> spec.lock_(recurse=recurse)
>>> try:
...     spec["a"] = spec["a"].clone()
... except RuntimeError:
...     print("failed!")
failed!
>>> try:
...     spec["a", "b"] = spec["a", "b"].clone()
...     print("succeeded!")
... except RuntimeError:
...     print("failed!")
succeeded!
>>> recurse = True
>>> spec.lock_(recurse=recurse)
>>> try:
...     spec["a", "b"] = spec["a", "b"].clone()
...     print("succeeded!")
... except RuntimeError:
...     print("failed!")
failed!

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 范围内采样的填充有 1 的张量。

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

one() 的代理。

pop(key: NestedKey, default: Any =_NoDefault.ZERO) → Any

从复合规范中移除并返回与指定键关联的值。

此方法在复合规范中搜索给定的键，将其移除，并返回其关联的值。如果未找到该键，则在指定默认值的情况下返回默认值，否则引发 KeyError。

参数：

• key (NestedKey) – 要从复合规范中移除的键。可以是单个键或嵌套键。

• default (任意类型, 可选) – 如果在组合规格中找不到指定的键，则返回的值。如果未提供且找不到键，则会引发 KeyError。

返回值：

从组合规格中移除的与指定键关联的值。

返回类型:

任意类型

引发:

KeyError – 如果在组合规格中找不到指定的键且未提供默认值。

project(val: TensorDictBase) → TensorDictBase

如果输入张量不在 TensorSpec 框中，则根据一些已定义的启发式方法将其映射回框中。

参数：

val (torch.Tensor) – 要映射到框中的张量。

返回值：

属于 TensorSpec 框的 torch.Tensor。

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

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

采样将在空间中均匀进行，除非该框是无界的，在这种情况下将抽取正态值。

参数：

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

返回值：

在 TensorSpec 框中采样的随机张量。

reshape(*shape) → T

重塑 TensorSpec。

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

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

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

详见 rand()。

separates(*keys: NestedKey, default: Optional[Any] = None) → Composite

通过将指定的键及其关联值提取到新的组合规格中来分割组合规格。

此方法遍历提供的键，将其从当前组合规格中移除，并将其添加到新的组合规格中。如果找不到键，则使用指定的默认值。返回新的组合规格。

参数：

• *keys (NestedKey) – 要从组合规格中提取的一个或多个键。每个键可以是单个键或嵌套键。

• default (任意类型, 可选) – 如果在组合规格中找不到指定的键，则使用的值。默认为 None。

返回值：

包含提取的键及其关联值的新组合规格。

返回类型:

Composite

注意

如果所有指定的键都找不到，则方法返回 None。

set(name: str, spec: TensorSpec) → StackedComposite

在组合规格中设置一个规格。

squeeze(dim: Optional[int] = None)

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

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

参数：

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

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

将 TensorSpec 转换到设备或 dtype。

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

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

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

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

参数：

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

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

返回值：

一个 np.ndarray。

type_check(value: Union[Tensor, TensorDictBase], selected_keys: Optional[Union[NestedKey, Sequence[NestedKey]]] = None)

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

参数：

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

• key (str, 可选) – 如果 TensorSpec 具有键，则值 dtype 将根据指示键指向的规格进行检查。

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

展开 TensorSpec。

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

unlock_(recurse: bool | None = None) → T

解锁 Composite 并允许修改其内容。

除非通过 recurse 参数另有指定，否则这仅是第一级锁定修改。

unsqueeze(dim: int)

返回一个新的规格，其中多了一个单例维度（在由 dim 指示的位置）。

参数：

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

values(include_nested: bool = False, leaves_only: bool = False, *, is_leaf: Callable[[type], bool] | None = None) → _CompositeSpecValuesView

Composite 的值。

参数：

• include_nested (bool, 可选) – 如果为 False，则返回的键不会嵌套。它们将仅表示根的直接子项，而不是整个嵌套序列，例如 Composite(next=Composite(obs=None)) 将导致键为 ["next"]. 默认值为 False，即不会返回嵌套键。

• leaves_only (bool, 可选) – 如果为 False，则返回的值将包含所有级别的嵌套，例如 Composite(next=Composite(obs=None)) 将导致键为 ["next", ("next", "obs")]。默认值为 False。

关键字参数：

is_leaf (callable, 可选) – 读取一个类型并返回一个布尔值，指示该类型是否应被视为叶节点。默认情况下，所有非 Composite 节点都被视为叶节点。

view(*shape) → T

重塑 TensorSpec。

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

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

返回框中填充零的张量。

注意

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

参数：

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

返回值：

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

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

zero() 的代理。