UnboundedDiscrete

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

torchrl.data.Unbounded 的一个特化版本，具有离散空间。

assert_is_in(value: Tensor) → None

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

参数：

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

cardinality() → int

spec 的基数。

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

clear_device_() → T

对所有叶子 spec (它们必须有设备) 而言是空操作。

对于 Composite spec，此方法将擦除设备。

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

spec 的设备。

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

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

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

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

参数：

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

关键字参数：

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

返回：

torch.Tensor 匹配所需张量 spec 的。

enumerate() → Any

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

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

此方法仅针对离散 spec 实现。

expand(*shape)

返回一个具有扩展形状的新 Spec。

参数：

*shape (tuple 或 int 可迭代对象) – Spec 的新形状。必须与当前形状可广播：其长度必须至少与当前形状长度相等，并且其最后一个值也必须兼容；即，它们只能在当前维度是单例时与之不同。

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

展平 TensorSpec。

查阅 flatten() 了解关于此方法的更多信息。

类方法 implements_for_spec(torch_function: Callable) → Callable

为 TensorSpec 注册一个 torch 函数覆盖。

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

对输入张量进行索引。

此方法用于编码一个或多个分类变量的 spec (例如，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 以及可能的其他元数据是否与 spec 的匹配。如果其中任何一项检查失败，is_in 方法将返回 False。

参数：

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

返回：

布尔值，指示值是否属于 TensorSpec 框。

make_neg_dim(dim: int) → T

将指定维度转换为 -1。

属性 ndim: int

spec 形状的维度数量。

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

ndimension() → int

spec 形状的维度数量。

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

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

返回框中一个填满 1 的张量。

注意

即使不能保证 1 属于 spec 领域，当违反此条件时，此方法不会引发异常。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

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

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

参数：

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

返回：

在 TensorSpec 框中采样的随机张量。

reshape(*shape) → T

重塑 TensorSpec。

查阅 reshape() 了解关于此方法的更多信息。

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

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

参阅 rand() 了解详情。

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

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

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

参数：

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

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

将 TensorSpec 转换为设备或 dtype。

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

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

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

这是 encode() 方法的逆操作。

参数：

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

• safe (bool) – 布尔值，指示是否应根据 spec 的领域对值执行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回：

一个 np.ndarray。

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

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

参数：

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

• key (str, optional) – 如果 TensorSpec 包含键，则会根据指定键指向的 Spec 来检查 value 的 dtype。

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

对 TensorSpec 进行 unflatten 操作。

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

unsqueeze(dim: int) → T

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

参数：

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

view(*shape) → T

重塑 TensorSpec。

查阅 reshape() 了解关于此方法的更多信息。

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

返回在该 box 中用零填充的张量。

注意

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

参数：

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

返回：

在该 TensorSpec 定义的范围内采样的一个用零填充的张量。

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

zero() 方法的别名。