CompositeSpec

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

TensorSpec 的组合。

参数：

• *args – 如果传递了无名参数，则它必须是字典，其键与预期在 CompositeSpec 对象中找到的键匹配。这对于使用元组索引构建嵌套的 CompositeSpec 非常有用。

• **kwargs (key (str) – value (TensorSpec)): 要存储的 tensorspec 字典。值可以是 None，在这种情况下，将假设 is_in 为 True，对应于相应张量，并且 project() 将不会有任何影响。 spec.encode 不能与缺失值一起使用。

变量：

• device (torch.device 或 None) – 如果未指定，则复合规范的设备为 None（对于 TensorDict 来说就是这样）。非空设备会将所有叶子限制为相同的设备。另一方面，None 设备允许叶子具有不同的设备。默认值为 None。

• shape (torch.Size) – 所有叶子的前导形状。相当于对应张量字典的批次大小。

示例

>>> pixels_spec = BoundedTensorSpec(
...    torch.zeros(3,32,32),
...    torch.ones(3, 32, 32))
>>> observation_vector_spec = BoundedTensorSpec(torch.zeros(33),
...    torch.ones(33))
>>> composite_spec = CompositeSpec(
...     pixels=pixels_spec,
...     observation_vector=observation_vector_spec)
>>> td = TensorDict({"pixels": torch.rand(10,3,32,32),
...    "observation_vector": torch.rand(10,33)}, batch_size=[10])
>>> print("td (rand) is within bounds: ", composite_spec.is_in(td))
td (rand) is within bounds:  True
>>> td = TensorDict({"pixels": torch.randn(10,3,32,32),
...    "observation_vector": torch.randn(10,33)}, batch_size=[10])
>>> print("td (randn) is within bounds: ", composite_spec.is_in(td))
td (randn) is within bounds:  False
>>> td_project = composite_spec.project(td)
>>> print("td modification done in place: ", td_project is td)
td modification done in place:  True
>>> print("check td is within bounds after projection: ",
...    composite_spec.is_in(td_project))
check td is within bounds after projection:  True
>>> print("random td: ", composite_spec.rand([3,]))
random td:  TensorDict(
    fields={
        observation_vector: Tensor(torch.Size([3, 33]), dtype=torch.float32),
        pixels: Tensor(torch.Size([3, 3, 32, 32]), dtype=torch.float32)},
    batch_size=torch.Size([3]),
    device=None,
    is_shared=False)

示例

>>> # we can build a nested composite spec using unnamed arguments
>>> print(CompositeSpec({("a", "b"): None, ("a", "c"): None}))
CompositeSpec(
    a: CompositeSpec(
        b: None,
        c: None))

CompositeSpec 支持嵌套索引

>>> spec = CompositeSpec(obs=None)
>>> spec["nested", "x"] = None
>>> print(spec)
CompositeSpec(
    nested: CompositeSpec(
        x: None),
    x: None)

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 (元组 或 可迭代的 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 or list) – 张量的索引

• tensor_to_index – 要索引的张量

返回值：

索引后的张量

is_empty()

复合规范是否包含规范。

is_in(val: Union[dict, TensorDictBase]) → 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"]. Default is ``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"]. Default is ``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)

重塑一个 tensorspec。

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

property sample

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

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

squeeze(dim: int | None = 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[str, Sequence[str]]] = None)

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

参数：

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

• key (str, 可选) – 如果 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"]. Default is ``False`，即不会返回嵌套键。

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

关键字参数：

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

view(*shape)

重塑一个 tensorspec。

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

zero(shape=None) → TensorDictBase

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

参数：

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

返回值：

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