Unbounded¶

class torchrl.data.Unbounded(*args, **kwargs)[source]¶

一个无界张量规格。

Unbounded 规格永远不会以这种形式出现，并且总是被子类化为 UnboundedContinuous 或 UnboundedDiscrete，具体取决于它们的 dtype（浮点 dtype 将导致 UnboundedContinuous 实例，所有其他 dtype 将导致 UnboundedDiscrete 实例）。

虽然它在上方和下方没有适当的限制，但此类仍然有一个 Box 空间，用于编码 dtype 接受的最大值和最小值。

参数:

shape (torch.Size) – Bounded 规格的形状。必须指定形状。low、high 和 shape 输入必须是可广播的。
device (str, int 或 torch.device, 可选) – 张量的设备。
dtype (str 或 torch.dtype, 可选) – 张量的 dtype。
domain (str) – “continuous” 或 “discrete”。可用于覆盖自动类型分配。

示例

>>> spec = Unbounded(shape=(), dtype=torch.float)
>>> spec
UnboundedContinuous(
    shape=torch.Size([]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)
>>> spec = Unbounded(shape=(), dtype=torch.int)
>>> spec
UnboundedDiscrete(
    shape=torch.Size([]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int32, contiguous=True)),
    device=cpu,
    dtype=torch.int32,
    domain=discrete)
>>> spec.to(torch.float)
UnboundedContinuous(
    shape=torch.Size([]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)
>>> spec = Unbounded(shape=(), dtype=torch.int, domain="continuous")
>>> spec
UnboundedContinuous(
    shape=torch.Size([]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int32, contiguous=True)),
    device=cpu,
    dtype=torch.int32,
    domain=continuous)

assert_is_in(value: Tensor) → None¶

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

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

clear_device_() → T¶

所有叶规格的无操作（必须具有设备）。

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

clone() → Unbounded[source]¶: 创建 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¶

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

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

参数:: val (np.ndarray 或 torch.Tensor) – 要编码为张量的值。
关键字参数:: ignore_device (bool, 可选) – 如果为 True，则将忽略规格设备。这用于将张量转换分组在对 TensorDict(..., device="cuda") 的调用中，这样会更快。
返回:: torch.Tensor，与所需的张量规格匹配。

expand(*shape)[source]¶

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

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

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[source]¶

如果值 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。

property ndim: int¶

spec 形状的维度数。

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

ndimension() → int¶

spec 形状的维度数。

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

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

返回空间中填充 1 的张量。

注意

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

参数:: shape (torch.Size) – one-tensor 的形状
返回:: 在 TensorSpec 空间中采样的填充 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 空间中，则根据某些定义的启发式方法将其映射回空间。

参数:: val (torch.Tensor) – 要映射到空间的张量。
返回:: 属于 TensorSpec 空间的 torch.Tensor。

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

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

除非空间是无界的，否则将在空间上均匀完成采样，在这种情况下将绘制正态值。

参数:: shape (torch.Size) – 随机张量的形状
返回:: 在 TensorSpec 空间中采样的随机张量。

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[source]¶

将 TensorSpec 转换为设备或 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, optional) – 如果 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() 的代理。

Unbounded¶

文档

教程

资源