Composite¶

class torchrl.data.Composite(*args, **kwargs)[源代码]¶

TensorSpecs 的组合。

如果 TensorSpec 是 Tensor 类别的集合描述，那么 Composite 类就类似于 TensorDict 类。与 TensorDict 一样，它有一个 shape（类似于 TensorDict 的 batch_size）和一个可选的 device。

参数:

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

变量:

device (torch.device 或 None) – 如果未指定，则 composite spec 的设备为 None（如 TensorDict 的情况）。非 None 的设备约束所有叶节点具有相同的设备。另一方面，None 设备允许叶节点具有不同的设备。默认为 None。
shape (torch.Size) – 所有叶节点的领先形状。等同于相应 tensordict 的批次大小。
data_cls (type, optional) – 应在 env 中强制执行的 tensordict 子类（TensorDict, TensorClass, tensorclass…）。默认为 None。
step_mdp_static (bool, optional) – spec 在 step_mdp 下是否是静态的。默认为 False。将 Composite 定义为 step_mdp_static spec 将导致在调用 step_mdp 时复制整个相关的 TensorDict/TensorClass 实例，而不是原地更新。

示例

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

断言一个张量是否属于该区域（box），否则抛出异常。

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

cardinality() → int[源代码]¶

规格的基数。

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

clear_device_()[源代码]¶: 清除 Composite 的设备。

clone() → Composite[源代码]¶

克隆 Composite spec。

锁定的 spec 不会产生锁定的克隆。

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 spec 才能有 None 设备。所有叶节点必须具有非零设备。

empty() → Composite[源代码]¶: 创建一个像 self 一样的 spec，但没有条目。

encode(val: np.ndarray | list | torch.Tensor | TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | TensorDictBase¶

使用指定的规格对值进行编码，并返回相应的张量。

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

参数:: val (np.ndarray 或 torch.Tensor) – 要编码为张量的值。
关键字参数:: ignore_device (bool, optional) – 如果 True，则将忽略 spec 设备。这用于在调用 TensorDict(..., device="cuda") 时将张量转换分组，这样效率更高。
返回:: 符合所需张量规格的 torch.Tensor。

enumerate(use_mask: bool = False) → TensorDictBase[源代码]¶

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

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

此方法仅为离散规格实现。

参数:: use_mask (bool, optional) – 如果 True 且 spec 有掩码，则排除被掩码的样本。默认为 False。

erase_memoize_cache() → None[源代码]¶: 清除用于缓存 encode 执行的缓存。

另请参阅

memoize_encode().

expand(*shape: tuple[int, ...] | torch.Size) → Composite[源代码]¶

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

参数:: *shape (tuple or iterable of 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 函数覆盖。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase[源代码]¶

索引输入张量。

此方法用于索引编码一个或多个分类变量的 spec（例如，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 = False)[源代码]¶

Composite spec 是否包含 spec。

参数:: recurse (bool) – 是否递归评估 spec 是否为空。如果为 True，则在没有叶节点时返回 True。如果为 False（默认值），则返回根级别是否存在任何 spec。

is_in(val: dict | TensorDictBase) → bool[源代码]¶

如果 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: Callable[[type], bool] | None = None, step_mdp_static_only: bool = False) → _CompositeSpecItemsView[源代码]¶

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 节点都被视为叶子。
step_mdp_static_only (bool, optional) – 如果 True，则仅返回在 step_mdp 下静态的键。默认为 False。

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

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 节点都被视为叶子。
step_mdp_static_only (bool, optional) – 如果 True，则仅返回在 step_mdp 下静态的键。默认为 False。

lock_(recurse: bool | None = None) → None[源代码]¶

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

recurse 参数控制锁定是否会传播到子 spec。当前默认为 False，但为了与 v0.8 中的 TensorDict API 一致，它将被改为 True。

示例

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

memoize_encode(mode: bool = True) → None[源代码]¶

创建 encode 方法的缓存可调用序列，以加快其执行速度。

这应该只在输入类型、形状等在给定规格的调用之间预期一致时使用。

参数:: mode (bool, optional) – 是否使用缓存。默认为 True。

另请参阅

缓存可以通过 erase_memoize_cache() 擦除。

property ndim¶

规格形状的维数。

相当于 len(spec.shape)。

ndimension()[源代码]¶

规格形状的维数。

相当于 len(spec.shape)。

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

返回盒中的一个填充一的张量。

注意

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

参数:: shape (torch.Size) – 一维张量的形状
返回:: 在 TensorSpec 区域中采样的填充一的张量。

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

pop(key: NestedKey, default: Any = _NoDefault.ZERO) → Any[源代码]¶

从 composite spec 中删除并返回与指定键关联的值。

此方法在 composite spec 中搜索指定键，将其删除，然后返回其关联的值。如果找不到键，则返回提供的默认值（如果指定），否则引发 KeyError。

参数:

key (NestedKey) – 要从 composite spec 中删除的键。它可以是单个键或嵌套键。
default (Any, optional) – 如果在 composite spec 中找不到指定的键，则返回的值。如果未提供且找不到键，则会引发 KeyError。

返回:

从 composite spec 中删除的与指定键关联的值。

返回类型:

任何

抛出:

KeyError – 如果在 composite spec 中找不到指定的键且未提供默认值。

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 (Any, optional) – 如果在复合规格中找不到指定的键，则使用的值。默认为 None。

返回:

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

返回类型:

Composite

注意

如果找不到任何指定的键，则该方法返回 None。

set(name: str, spec: TensorSpec) → Composite[源代码]¶: 在 Composite 规格中设置一个规格。

squeeze(dim: int | None = None) → Composite[源代码]¶

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

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

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

to(dest: torch.dtype | DEVICE_TYPING) → Composite[源代码]¶

将 TensorSpec 转换为设备或 dtype。

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

to_numpy(val: TensorDict, safe: bool | None = None) → dict[源代码]¶

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

这是 encode() 操作的逆操作。

参数:

val (torch.Tensor) – 要转换为 numpy 的张量。
safe (bool) – 一个布尔值，指示是否应对值相对于 spec 域进行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回:

一个 np.ndarray。

type_check(value: torch.Tensor | TensorDictBase, selected_keys: str | Sequence[str] | None = None)[源代码]¶

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

参数:

value (torch.Tensor) – 必须检查其 dtype 的张量。
key (str, optional) – 如果 TensorSpec 具有键，则将检查值 dtype 是否与指定键指向的规格匹配。

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

解展一个 TensorSpec。

有关此方法的详细信息，请参见 unflatten()。

unlock_(recurse: bool | None = None) → T[源代码]¶

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

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

unsqueeze(dim: int) → Composite[源代码]¶

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

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

values(include_nested: bool = False, leaves_only: bool = False, *, is_leaf: Callable[[type], bool] | None = None, step_mdp_static_only: bool = False) → _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) – 读取一个类型并返回一个布尔值，指示该类型是否应被视为叶子。默认情况下，所有非 Composite 节点都被视为叶子。
step_mdp_static_only (bool, optional) – 如果 True，则仅返回在 step_mdp 下静态的键。默认为 False。

view(*shape) → T¶

重塑一个 TensorSpec。

有关此方法的详细信息，请参见 reshape()。

zero(shape: Optional[Size] = None) → TensorDictBase[源代码]¶

返回盒中的零填充张量。

注意

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

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

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

Composite¶

文档

教程

资源