UnboundedContinuous

类 torchrl.data.UnboundedContinuous(*args, **kwargs)

它是 torchrl.data.Unbounded 的一个特殊版本，具有连续空间。

assert_is_in(value: Tensor) → None

断言张量是否属于该范围框，否则抛出异常。

参数:

value (torch.Tensor) – 待检查的值。

cardinality() → int

该规范的基数。

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

clear_device_() → T

对于所有叶子规范（必须具有设备），此操作为空操作（no-op）。

对于 Composite 规范，此方法将擦除设备信息。

clone() → Unbounded

创建 TensorSpec 的副本。

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

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

更多信息请参阅 is_in()。

cpu()

将 TensorSpec 转换为 ‘cpu’ 设备。

cuda(device=None)

将 TensorSpec 转换为 ‘cuda’ 设备。

属性 device: device

该规范的设备。

只有 Composite 规范可以有 None 设备。所有叶子必须具有非空设备。

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

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

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

参数:

val (np.ndarray 或 torch.Tensor) – 待编码为张量的值。

关键字参数:

ignore_device (bool, optional) – 如果为 True，则将忽略规范的设备。这用于将张量类型转换分组到 TensorDict(..., device="cuda") 调用中，这样更快。

返回:

与所需张量规范匹配的 torch.Tensor。

enumerate() → Any

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

样本将沿第一维堆叠。

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

expand(*shape)

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

参数:

*shape (tuple 或 iterable of int) – 规范的新形状。必须与当前形状可广播：其长度必须至少与当前形状长度相同，并且其最后一个值也必须兼容；即只有当前维度为单例时，它们才能与当前形状不同。

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

展平一个 TensorSpec。

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

classmethod 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 或 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_in(val: Tensor) → bool

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

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

参数:

val (torch.Tensor) – 待检查的值。

返回:

指示值是否属于 TensorSpec 范围框的布尔值。

make_neg_dim(dim: int) → T

将特定维度转换为 -1。

属性 ndim: int

规范形状的维度数量。

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

ndimension() → int

规范形状的维度数量。

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() 的代理。

project(val: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase

如果输入张量不在 TensorSpec 范围内，它将根据某些定义的启发式方法将其映射回范围内。

参数:

val (torch.Tensor) – 待映射到范围框的张量。

返回:

属于 TensorSpec 范围框的 torch.Tensor。

rand(shape: Optional[Size] = None) → Tensor

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

采样将在空间中均匀进行，除非该范围框无界，此时将抽取正态分布的值。

参数:

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

返回:

在 TensorSpec 范围内采样的随机张量。

reshape(*shape) → T

重塑一个 TensorSpec。

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

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

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

详情请参阅 rand()。

squeeze(dim: int | None = None) → T

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

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

参数:

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

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

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

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

to_numpy(val: torch.Tensor | TensorDictBase, safe: bool = None) → np.ndarray | dict

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

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

参数:

• val (torch.Tensor) – 待转换为 numpy 的张量。

• safe (bool) – 布尔值，指示是否应对值进行检查以对抗规范域。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回:

一个 np.ndarray。

type_check(value: Tensor, key: Optional[NestedKey] = None) → None

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

参数:

• value (torch.Tensor) – 待检查数据类型的张量。

• key (str, optional) – 如果 TensorSpec 有键，则将根据指示的键指向的规范检查值的数据类型。

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

解除展平一个 TensorSpec。

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

unsqueeze(dim: int) → T

返回一个新的 Spec，增加一个单维度（在由 dim 指定的位置）。

参数:

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

view(*shape) → T

重塑一个 TensorSpec。

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

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

返回一个根据此 Spec 填充零的张量。

注意

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

参数:

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

返回:

一个根据 TensorSpec 填充零的张量。

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

zero() 的别名。