StackedComposite¶

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

堆叠复合规范的惰性表示。

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

允许索引，但仅沿堆叠维度进行。

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

assert_is_in(value: Tensor) → None¶

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

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

cardinality(*args, **kwargs) → Any[source]¶

规范的基数。

这指的是规范中可能结果的数量。假定复合规范的基数是所有可能结果的笛卡尔积。

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

clone() → T¶

克隆 Composite 规范。

锁定的规范不会产生锁定的克隆。

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 规范可以具有 None 设备。所有叶节点必须具有非空设备。

empty()[source]¶: 创建一个类似自身的规范，但不包含条目。

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

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

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

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

enumerate() → TensorDictBase[source]¶

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

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

此方法仅针对离散规范实现。

expand(*shape)[source]¶

返回具有扩展形状的新 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[source]¶

对输入张量进行索引。

此方法用于编码一个或多个分类变量（例如 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)¶

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

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

is_in(value) → bool[source]¶

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

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

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

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

Composite 的项。

参数:

include_nested (bool, optional) – 如果为 False，返回的键将不是嵌套的。它们仅表示根节点的直接子节点，而不是整个嵌套序列，即 Composite(next=Composite(obs=None)) 将导致键 ["next"]. Default is ``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: Callable[[type], bool] | None = None) → _CompositeSpecKeysView[source]¶

Composite 的键。

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

参数:

include_nested (bool, optional) – 如果为 False，返回的键将不是嵌套的。它们仅表示根节点的直接子节点，而不是整个嵌套序列，即 Composite(next=Composite(obs=None)) 将导致键 ["next"]. Default is ``False`，即不返回嵌套键。
leaves_only (bool, optional) – 如果为 False，返回的值将包含所有嵌套级别，即 Composite(next=Composite(obs=None)) 将导致键 ["next", ("next", "obs")]。默认值为 False。

关键字参数:

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

lock_(recurse: bool | None = None) → T¶

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

recurse 参数控制锁定是否将传播到子规范。当前默认值为 False，但在 v0.8 版本中将更改为 True，以与 TensorDict API 保持一致。

示例

>>> 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)¶: 将特定维度转换为 -1。

property ndim¶

规范形状的维度数量。

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

ndimension()[source]¶

规范形状的维度数量。

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

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

返回框中填充一值的张量。

注意

即使无法保证 1 属于规范域，此方法也不会在违反此条件时引发异常。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, 可选) – 如果在 composite spec 中未找到指定键，则返回的值。如果未提供且未找到键，则会引发 KeyError。

返回值:

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

返回类型:

Any

抛出异常:

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

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

如果输入的张量不在 TensorSpec 的 'box' 内，它将根据一些启发式规则将其映射回 'box'。

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

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

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

采样将在空间中均匀进行，除非 'box' 是无界的，在这种情况下将抽取正态分布值。

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

reshape(*shape) → T¶

重塑一个 TensorSpec。

查看 reshape() 以获取更多信息。

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

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

详情请参见 rand()。

separates(*keys: NestedKey, default: Optional[Any] = None) → Composite¶

通过提取指定的键及其关联的值来分割 composite spec，并放入一个新的 composite spec 中。

此方法遍历提供的键，将其从当前 composite spec 中移除，并将其添加到新的 composite spec 中。如果未找到键，则使用指定的默认值。返回新的 composite spec。

参数:

*keys (NestedKey) – 要从 composite spec 中提取的一个或多个键。每个键可以是一个单一键或嵌套键。
default (Any, 可选) – 如果在 composite spec 中未找到指定键，则使用的值。默认为 None。

返回值:

包含提取的键及其关联值的新 composite spec。

返回类型:

Composite

注意

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

set(name: str, spec: TensorSpec) → StackedComposite[source]¶: 在 Composite spec 中设置一个 spec。

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

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

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

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

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

将 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[NestedKey, Sequence[NestedKey]]] = None)[source]¶

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

参数:

value (torch.Tensor) – 要检查其 dtype 的张量。
key (str, 可选) – 如果 TensorSpec 包含键，则将对照指定键指向的 spec 检查值的 dtype。

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

展开一个 TensorSpec。

查看 unflatten() 以获取更多信息。

unlock_(recurse: bool | None = None) → T¶

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

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

unsqueeze(dim: int)¶

返回一个新 Spec，其中增加了（由 dim 指示位置的）一个大小为 1 的维度。

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

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

Composite 的值。

参数:

include_nested (bool, optional) – 如果为 False，返回的键将不是嵌套的。它们仅表示根节点的直接子节点，而不是整个嵌套序列，即 Composite(next=Composite(obs=None)) 将导致键 ["next"]. Default is ``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]¶

注意

在 'box' 中返回一个填充了零的张量。

参数:: 即使不能保证 0 属于 spec 域，当违反此条件时此方法也不会引发异常。`zero` 的主要用例是生成空的数据缓冲区，而不是有意义的数据。
返回值:: shape (torch.Size) – 零填充张量的形状。

在 TensorSpec 的 'box' 中采样的零填充张量。: zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶

StackedComposite¶

文档

查看文档

查看教程