NonTensorSpec

class torchrl.data.NonTensorSpec(shape: Union[torch.Size, int] = torch.Size([1]), device: Optional[DEVICE_TYPING] = None, dtype: torch.dtype | None = None, **kwargs)

非张量数据的规范。

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 or torch.Tensor) – 要编码为张量的值。

关键字参数:

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

返回:

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

expand(*shape)

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

参数:

*shape (tuple or iterable of int) – 规范的新形状。必须符合当前形状：其长度必须至少与当前形状长度一样长，并且其最后的值也必须符合；即它们只能在当前维度为单一值时才与其不同。

flatten(start_dim, end_dim)

扁平化一个 tensorspec。

有关此方法的更多信息，请查看 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)

返回规范定义的空间中的随机张量。如果框无界，则采样将是均匀的。

参数:

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

返回:

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

reshape(*shape)

重塑一个 tensorspec。

有关此方法的更多信息，请查看 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 环境变量的值。

返回:

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)

展开一个 tensorspec。

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

view(*shape)

重塑一个 tensorspec。

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

zero(shape=None)

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

参数:

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

返回:

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