Composite¶

class torchrl.data.Composite(*args, **kwargs)[source]¶

TensorSpec 的组合。

如果 TensorSpec 是 Tensor 类别的集合描述，则 Composite 类类似于 TensorDict 类。与 TensorDict 类似，它具有 shape （类似于 TensorDict 的 batch_size）和可选的 device。

参数:

*args – 如果传递未命名的参数，则它必须是一个字典，其键与要在 Composite 对象中找到的预期键匹配。这对于使用元组索引构建嵌套的 CompositeSpecs 非常有用。
**kwargs (key (str) – value (TensorSpec)): 要存储的 tensorspecs 字典。值可以为 None，在这种情况下，对于相应的张量，is_in 将被假定为 True，并且 project() 将不起作用。 spec.encode 不能用于缺失值。

变量:

device (torch.device 或 None) – 如果未指定，则 composite spec 的设备为 None （与 TensorDicts 的情况相同）。非空的设备约束所有叶子具有相同的设备。另一方面，None 设备允许叶子具有不同的设备。默认为 None。
shape (torch.Size) – 所有叶子的前导形状。等效于相应 tensordicts 的批大小。

示例

>>> pixels_spec = Bounded(
...     low=torch.zeros(4, 3, 32, 32),
...     high=torch.ones(4, 3, 32, 32),
...     dtype=torch.uint8
... )
>>> observation_vector_spec = Bounded(
...     low=torch.zeros(4, 33),
...     high=torch.ones(4, 33),
...     dtype=torch.float)
>>> composite_spec = Composite(
...     pixels=pixels_spec,
...     observation_vector=observation_vector_spec,
...     shape=(4,)
... )
>>> composite_spec
Composite(
    pixels: BoundedDiscrete(
        shape=torch.Size([4, 3, 32, 32]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([4, 3, 32, 32]), device=cpu, dtype=torch.uint8, contiguous=True),
            high=Tensor(shape=torch.Size([4, 3, 32, 32]), device=cpu, dtype=torch.uint8, contiguous=True)),
        device=cpu,
        dtype=torch.uint8,
        domain=discrete),
    observation_vector: BoundedContinuous(
        shape=torch.Size([4, 33]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([4, 33]), device=cpu, dtype=torch.float32, contiguous=True),
            high=Tensor(shape=torch.Size([4, 33]), device=cpu, dtype=torch.float32, contiguous=True)),
        device=cpu,
        dtype=torch.float32,
        domain=continuous),
    device=None,
    shape=torch.Size([4]))
>>> td = composite_spec.rand()
>>> td
TensorDict(
    fields={
        observation_vector: Tensor(shape=torch.Size([4, 33]), device=cpu, dtype=torch.float32, is_shared=False),
        pixels: Tensor(shape=torch.Size([4, 3, 32, 32]), device=cpu, dtype=torch.uint8, is_shared=False)},
    batch_size=torch.Size([4]),
    device=None,
    is_shared=False)
>>> # we can build a nested composite spec using unnamed arguments
>>> print(Composite({("a", "b"): None, ("a", "c"): None}))
Composite(
    a: Composite(
        b: None,
        c: None,
        device=None,
        shape=torch.Size([])),
    device=None,
    shape=torch.Size([]))

assert_is_in(value: Tensor) → None¶

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

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

clear_device_()[source]¶: 清除 Composite 的设备。

clone() → Composite[source]¶: 创建 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 specs 可以具有 None 设备。所有叶子都必须具有非空设备。

empty()[source]¶: 创建类似于 self 的 spec，但没有条目。

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

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

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

参数:: val (np.ndarray 或 torch.Tensor) – 要编码为张量的值。
关键字参数:: ignore_device (bool, optional) – 如果为 True，则将忽略 spec 设备。这用于在调用 TensorDict(..., device="cuda") 中对张量转换进行分组，这会更快。
返回值:: 与所需张量规格匹配的 torch.Tensor。

expand(*shape)[source]¶

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

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

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

展平 TensorSpec。

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

get(item, default=_NoDefault.ZERO)[source]¶

从 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()[source]¶: composite spec 是否包含 specs。

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

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

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

参数:: val (torch.Tensor) – 要检查的值。
返回值:: 布尔值，指示值是否属于 TensorSpec 框。

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

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) – 读取类型并返回一个布尔值，指示该类型是否应被视为叶子。默认情况下，所有非 Composite 节点都被视为叶子。

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

Composite 的键。

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) – 读取类型并返回一个布尔值，指示该类型是否应被视为叶子。默认情况下，所有非 Composite 节点都被视为叶子。

lock_(recurse=False)[source]¶

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

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

叶子 specs 始终可以就地修改，但不能在其 Composite 父项中替换。

示例

>>> 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¶

spec 形状的维度数。

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

ndimension()[source]¶

spec 形状的维度数。

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

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

返回框中填充 1 的张量。

注意

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

参数:: shape (torch.Size) – one-tensor 的形状
返回值:: 在 TensorSpec 框中采样的填充 1 的张量。

ones(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶: 代理到 one()。

project(val: TensorDictBase) → TensorDictBase[source]¶

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

参数:: val (torch.Tensor) – 要映射到框中的张量。
返回值:: 属于 TensorSpec 框的 torch.Tensor。

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

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

除非框是无界的，否则采样将在空间上均匀完成，在这种情况下将绘制正态值。

参数:: shape (torch.Size) – 随机张量的形状
返回值:: 在 TensorSpec 框中采样的随机张量。

reshape(*shape) → T¶

重塑 TensorSpec。

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

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

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

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

squeeze(dim: Optional[int] = None)[source]¶

返回一个新的 Spec，其中删除了所有尺寸为 1 的维度。

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

参数:: dim (int 或 None) – 应用 squeeze 操作的维度

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

将 TensorSpec 转换为设备或 dtype。

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

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

返回输入张量的 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)[source]¶

检查输入值 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)[source]¶

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

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

unsqueeze(dim: int)[source]¶

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

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

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

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) – 读取类型并返回一个布尔值，指示该类型是否应被视为叶子。默认情况下，所有非 Composite 节点都被视为叶子。

view(*shape) → T¶

重塑 TensorSpec。

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

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

返回框中的零填充张量。

注意

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

参数:: shape (torch.Size) – 零张量的形状
返回值:: 在 TensorSpec 框中采样的零填充张量。

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶: 代理到 zero()。

Composite¶

文档

教程

资源