UnboundedDiscrete

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

torchrl.data.Unbounded 的专门版本，具有离散空间。

assert_is_in(value: Tensor) → None

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

参数:

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

clear_device_() → T

所有叶子规格的无操作 (必须具有设备)。

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

clone() → Unbounded

创建 TensorSpec 的副本。

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

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

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

cpu()

将 TensorSpec 转换为 ‘cpu’ 设备。

cuda(device=None)

将 TensorSpec 转换为 ‘cuda’ 设备。

property device: device

规格的设备。

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

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

根据指定的规格编码值，并返回相应的张量。

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

参数:

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

关键字参数:

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

返回:

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

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 函数覆盖。

abstract index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: torch.Tensor | tensordict.base.TensorDictBase) → torch.Tensor | tensordict.base.TensorDictBase

索引输入张量。

参数:

• index (int, torch.Tensor, slice 或 list) – 张量的索引

• tensor_to_index – 要索引的张量

返回:

索引张量

is_in(val: Tensor) → bool

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

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

参数:

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

返回:

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

make_neg_dim(dim: int) → T

将指定的维度转换为 -1。

property ndim: int

spec shape 的维度数量。

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

ndimension() → int

spec shape 的维度数量。

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

one(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

返回 box 中填充为 1 的张量。

注意

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

参数:

shape (torch.Size) – one-tensor 的形状

返回:

在 TensorSpec box 中采样的一个填充为 1 的张量。

ones(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

one() 的代理。

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

如果输入张量不在 TensorSpec box 中，它会根据定义的启发式方法将其映射回 box 中。

参数:

val (torch.Tensor) – 要映射到 box 的张量。

返回:

属于 TensorSpec box 的 torch.Tensor。

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

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

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

参数:

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

返回:

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

reshape(*shape) → T

重塑 TensorSpec。

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

sample(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

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

有关详细信息，请参阅 rand()。

squeeze(dim: Optional[int] = None) → T

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

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

参数:

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

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

将 TensorSpec 转换为 device 或 dtype。

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

to_numpy(val: torch.Tensor | tensordict.base.TensorDictBase, safe: Optional[bool] = None) → numpy.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*, *可选*) – 如果 TensorSpec 有键，则将根据指示的键指向的 spec 检查值 dtype。

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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

返回box中的零填充张量。

注意

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

参数:

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

返回:

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

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

代理到 zero()。