LazyStackedCompositeSpec

class torchrl.data.LazyStackedCompositeSpec(*specs: tuple[T, ...], dim: int)

复合规范堆栈的延迟表示。

沿一个维度将复合规范堆叠在一起。当绘制随机样本时，将返回 LazyStackedTensorDict。

允许索引，但仅沿堆栈维度。

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

assert_is_in(value: Tensor) → None

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

参数：

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

clear_device_()

清除 CompositeSpec 的设备。

contains(item)

返回样本是否包含在 TensorSpec 定义的空间内。

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

empty()

创建一个类似于 self 的规范，但没有条目。

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

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

参数：

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

关键字参数：

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

返回值：

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

expand(*shape)

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

参数：

*shape (tuple 或 int 的可迭代对象) – 规范的新形状。必须符合当前形状：其长度必须至少与当前形状长度一样长，并且其最后一个值也必须符合；即，如果当前维度是单例，则它们只能与之不同。

flatten(start_dim, end_dim)

展平 tensorspec。

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

get(item, default=<object object>)

从 CompositeSpec 获取项目。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

注册 TensorSpec 的 torch 函数覆盖。

abstract index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: Tensor) → Tensor

索引输入张量。

参数：

• index (int, torch.Tensor, slice 或 list) – 张量的索引

• tensor_to_index – 要索引的张量

返回值：

索引后的张量

is_empty()

复合规格是否包含规格。

is_in(value) → bool

如果值 val 在由 TensorSpec 定义的范围内，则返回 True，否则返回 False。

参数：

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

返回值：

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

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

CompositeSpec 的项目。

参数：

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

• leaves_only (bool, optional) – 如果 False，则返回的值将包含每个嵌套级别，即 CompositeSpec(next=CompositeSpec(obs=None)) 将导致键 ["next", ("next", "obs")]。默认为 False。

关键字参数：

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

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

CompositeSpec 的键。

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

参数：

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

• leaves_only (bool, optional) – 如果 False，则返回的值将包含每个嵌套级别，即 CompositeSpec(next=CompositeSpec(obs=None)) 将导致键 ["next", ("next", "obs")]。默认为 False。

关键字参数：

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

lock_(recurse=False)

锁定 CompositeSpec 并阻止修改其内容。

这只是一个第一级锁定，除非通过 recurse 参数另行指定。

叶子规格始终可以在原地修改，但不能在其 CompositeSpec 父级中替换。

示例

>>> shape = [3, 4, 5]
>>> spec = CompositeSpec(
...         a=CompositeSpec(
...         b=CompositeSpec(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!

project(val: TensorDictBase) → TensorDictBase

如果输入张量不在 TensorSpec 范围内，则根据一些启发式将其映射回该范围。

参数：

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

返回值：

属于 TensorSpec 范围的 torch.Tensor。

rand(shape=None) → TensorDictBase

返回规格定义的空间中的随机张量。除非范围是无界的，否则采样将是均匀的。

参数：

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

返回值：

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

reshape(*shape)

重塑张量规格。

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

property sample

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

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

squeeze(dim: Optional[int] = None)

返回一个新的 Spec，其中所有大小为 1 的维度都被删除。

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

参数：

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

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

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

参数：

• 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, optional) – 如果 TensorSpec 有键，则会根据指示键指向的规范检查值的 dtype。

unflatten(dim, sizes)

展平 TensorSpec。

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

unlock_(recurse=False)

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

这只是一个第一级锁修改，除非通过 recurse 参数另行指定。

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

CompositeSpec 的值。

参数：

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

• leaves_only (bool, optional) – 如果 False，则返回的值将包含每个嵌套级别，即 CompositeSpec(next=CompositeSpec(obs=None)) 将导致键 ["next", ("next", "obs")]。默认为 False。

关键字参数：

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

view(*shape)

重塑张量规格。

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

zero(shape=None) → TensorDictBase

返回框中一个填充为零的张量。

参数：

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

返回值：

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