CompositeSpec

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

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

assert_is_in(value: Tensor) → None

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

参数:

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

clear_device_()

清除 Composite 的设备。

clone() → Composite

创建 TensorSpec 的副本。

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

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

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

cpu()

将 TensorSpec 转换为 ‘cpu’ 设备。

cuda(device=None)

将 TensorSpec 转换为 ‘cuda’ 设备。

property device: Union[device, str, int]

Spec 的设备。

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

empty()

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

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

根据指定的 spec 编码一个值，并返回相应的张量。

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

参数:

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

关键字参数:

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

返回:

torch.Tensor，与所需的张量 spec 匹配。

expand(*shape)

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

参数:

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

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

展平 TensorSpec。

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

get(item, default=_NoDefault.ZERO)

从 Composite 获取一个条目。

如果该条目不存在，则可以传递默认值。

classmethod implements_for_spec(torch_function: Callable) → Callable

为 TensorSpec 注册一个 torch 函数覆盖。

abstract index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: torch.Tensor | tensordict.base.TensorDictBase) → torch.Tensor | tensordict.base.TensorDictBase

索引输入张量。

参数:

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

• tensor_to_index – 要索引的张量

返回:

索引后的张量

is_empty()

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

is_in(val: Union[dict, TensorDictBase]) → bool

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

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

参数:

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

返回:

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

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

复合对象的条目。

参数:

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

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

关键字参数:

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

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

复合对象的键。

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

参数:

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

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

关键字参数:

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

lock_(recurse=False)

锁定复合对象并阻止修改其内容。

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

叶规范始终可以在原地修改，但不能在其复合父对象中替换。

示例

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

将特定维度转换为 -1。

property ndim

规范形状的维度数。

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

ndimension()

规范形状的维度数。

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

one(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

返回 box 中填充为 1 的张量。

注意

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

参数:

shape (torch.Size) – one-tensor 的形状

返回:

在 TensorSpec box 中采样的填充为 1 的张量。

ones(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

是 one() 的代理。

project(val: TensorDictBase) → 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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

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

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

squeeze(dim: Optional[int] = None)

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

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

参数:

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

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

将 TensorSpec 转换为设备或 dtype。

如果没有进行任何更改，则返回相同的 spec。

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

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

此方法旨在作为 encode() 的逆运算。

参数:

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

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

返回:

一个 np.ndarray。

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

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

参数:

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

• key (str, optional) – 如果 TensorSpec 具有键，则将根据指示的键指向的 spec 检查值 dtype。

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

展开 TensorSpec。

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

unlock_(recurse=False)

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

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

unsqueeze(dim: int)

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

参数:

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

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

Composite 的值。

参数:

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

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

关键字参数:

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

view(*shape) → T

重塑 TensorSpec。

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

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

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

注意

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

参数:

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

返回:

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

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

代理到 zero()。