UnboundedContinuousTensorSpec

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

已弃用版本，对应于 torchrl.data.Unbounded 的连续空间。

assert_is_in(value: Tensor) → None

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

参数:

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

cardinality() → int

规范的基数。

这指的是一个规范中可能的 outcomes (结果) 数量。假设组合规范的基数是所有可能结果的笛卡尔积。

clear_device_() → T

对所有叶子规范而言，这是一个无操作 (它们必须有设备)。

对于 Composite 规范，此方法将清除设备。

clone() → Unbounded

创建 TensorSpec 的副本。

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

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

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

cpu()

将 TensorSpec 转换到 ‘cpu’ 设备。

cuda(device=None)

将 TensorSpec 转换到 ‘cuda’ 设备。

property device: device

规范的设备。

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

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

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

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

参数:

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

关键字参数:

ignore_device (bool, 可选) – 如果为 True，将忽略规范设备。这用于在调用 TensorDict(..., device="cuda") 中对张量转换进行分组，这样更快。

返回:

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

enumerate() → Any

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

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

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

expand(*shape)

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

参数:

*shape (tuple 或 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。

property ndim: int

规范形状的维度数量。

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

ndimension() → int

规范形状的维度数量。

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

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

返回一个填充一的张量，位于该框中。

注意

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

参数:

shape (torch.Size) – 填充一的张量的形状。

返回:

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

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 时，仅在该维度上执行 squeeze 操作。

参数:

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

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 (布尔值) – 布尔值，指示是否应根据 spec 的域对值执行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回:

一个 np.ndarray。

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

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

参数:

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

• key (str, 可选的) – 如果 TensorSpec 包含键，则将对照指定键指向的 spec 检查值的数据类型。

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

展开一个 TensorSpec。

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

unsqueeze(dim: int) → T

返回一个在指定维度 (`dim`) 处增加一个单维度的新 Spec。

参数:

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

view(*shape) → T

重塑 TensorSpec。

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

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

返回 box 中填充零的张量。

注意

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

参数:

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

返回:

在 TensorSpec box 中抽样的填充零的张量。

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

zero() 的代理。