BoundedTensorSpec

class torchrl.data.BoundedTensorSpec(low: Optional[Union[float, Tensor, ndarray]] = None, high: Optional[Union[float, Tensor, ndarray]] = None, shape: Optional[Union[Size, int]] = None, device: Optional[Union[device, str, int]] = None, dtype: Optional[Union[dtype, str]] = None, **kwargs)

一个有界的连续张量规范。

参数:

• low (np.ndarray, torch.Tensor 或 数字) – 框的下界。

• high (np.ndarray, torch.Tensor 或 数字) – 框的上界。

• device (str, int 或 torch.device, 可选) – 张量的设备。

• dtype (str 或 torch.dtype, 可选) – 张量的 dtype。

assert_is_in(value: Tensor) → None

断言一个张量是否属于框，否则抛出异常。

参数:

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

clear_device_()

对于所有叶规范 (必须有设备) 来说是一个无操作。

contains(item)

返回一个样本是否包含在 TensorSpec 定义的空间内。

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

encode(val: Union[ndarray, Tensor], *, ignore_device=False) → Tensor

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

参数:

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

关键字参数:

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

返回:

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

expand(*shape)

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

参数:

*shape (tuple 或 int 的可迭代对象) – Spec 的新形状。必须符合当前形状：其长度必须至少与当前形状长度一样长，并且其最后的值也必须符合；即它们只能在当前维度为单例时才与当前维度不同。

flatten(start_dim, end_dim)

将张量规范展平。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

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

abstract index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: Tensor) → Tensor

对输入张量进行索引。

参数:

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

• tensor_to_index – 要索引的张量

返回:

索引的张量

is_in(val: Tensor) → bool

如果值 val 位于 TensorSpec 定义的框中，则返回 True，否则返回 False。

参数:

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

返回:

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

project(val: Tensor) → Tensor

如果输入张量不在 TensorSpec 框中，它会根据一些启发式方法将其映射回框中。

参数:

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

返回:

属于 TensorSpec 框的 torch.Tensor。

rand(shape=None) → Tensor

在规范定义的空间中返回一个随机张量。除非框是无界的，否则采样将是均匀的。

参数:

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

返回:

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

reshape(*shape)

重新整形张量规范。

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

property sample

在规范定义的空间中返回一个随机张量。

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

squeeze(dim: int | None = None)

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

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

参数:

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

to_numpy(val: Tensor, safe: Optional[bool] = None) → ndarray

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

参数:

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

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

返回:

a np.ndarray

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

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

参数:

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

• key (str, optional) – 如果 TensorSpec 具有键，则将针对由指示键指向的规范检查值 dtype。

unflatten(dim, sizes)

将张量规范展平。

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

view(*shape)

重新整形张量规范。

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

zero(shape=None) → Tensor

在框中返回一个用零填充的张量。

参数:

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

返回:

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