CompositeSpec¶

类 torchrl.data.CompositeSpec(*args, **kwargs)[源]¶

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

assert_is_in(value: Tensor) → None¶

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

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

cardinality() → int¶

该规约的基数。

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

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

clone() → Composite¶

克隆 Composite 规约。

被锁定的规约不会产生被锁定的克隆。

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

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

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

cpu()¶: 将 TensorSpec 转换为 ‘cpu’ 设备。

cuda(device=None)¶: 将 TensorSpec 转换为 ‘cuda’ 设备。

属性 device: Union[device, str, int]¶

该规约的设备。

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

empty()¶: 创建一个与自身类似的规约，但不包含任何条目。

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

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

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

参数:: val (np.ndarray or torch.Tensor) – 要编码为张量的值。
关键字参数:: ignore_device (bool, optional) – 如果为 True，将忽略规约的设备。这用于在调用 TensorDict(..., device="cuda") 中将张量转换组合在一起，这样更快。
返回:: 符合所需张量规约的 torch.Tensor。

enumerate() → TensorDictBase¶

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

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

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

expand(*shape)¶

返回具有扩展后形状的新规约。

参数:: *shape (tuple or iterable of int) – 规约的新形状。必须能与当前形状广播：其长度必须至少与当前形状长度相等，其最后一个值也必须一致；即只有当当前维度是单例时，它们才可以不同。

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

展平一个 TensorSpec。

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

get(item, default=_NoDefault.ZERO)¶

从 Composite 中获取一个条目。

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

类方法 implements_for_spec(torch_function: Callable) → Callable¶: 为 TensorSpec 注册一个 torch 函数重载。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase¶

为输入张量建立索引。

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

复合规约是否包含规约。

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

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

如果值 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¶

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: Callable[[type], bool] | None =None) → _CompositeSpecKeysView¶

Composite 的键。

键参数反映了 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: 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) → T¶: 将指定维度转换为 -1。

属性 ndim¶

规约形状的维度数量。

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

ndimension()¶

规约形状的维度数量。

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

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

返回范围内一个填充 1 的张量。

注意

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

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

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

pop(key: NestedKey, default: Any = _NoDefault.ZERO) → Any¶

从复合规约中移除并返回与指定键关联的值。

此方法在复合规约中搜索给定键，移除它，并返回其关联的值。如果未找到键，如果指定了默认值，则返回提供的默认值，否则引发 KeyError 异常。

参数:

key (NestedKey) – 要从复合规约中移除的键。它可以是单个键或嵌套键。
default (Any, optional) – 如果在复合规约中未找到指定键，则返回的值。如果未提供此参数且未找到键，则引发 KeyError 异常。

返回:

从复合规约中移除的、与指定键关联的值。

返回类型:

Any

引发:

KeyError – 如果在复合规约中未找到指定键且未提供默认值。

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¶: 在组合规范中设置一个规范。

squeeze(dim: int | None = None)¶

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

如果给定了 dim，则仅在该维度上执行压缩操作。

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

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

将 TensorSpec 转换到设备或数据类型。

如果未做任何更改，则返回相同的规范。

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

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

这旨在成为 encode() 的逆操作。

参数:

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, optional) – 如果 TensorSpec 具有键，则值的 dtype 将对照指定键指向的规范进行检查。

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

反展平 TensorSpec。

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

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

解锁组合规范并允许修改其内容。

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

unsqueeze(dim: int)¶

返回一个新的规范，该规范在（由 dim 指示的位置）增加一个大小为 1 的维度。

参数:: dim (int or None) – 应用扩展操作的维度。

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

组合规范的值。

参数:

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¶

返回一个在该范围内的零填充张量。

注意

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

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

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: zero() 的代理。

CompositeSpec¶

文档

教程

资源