Bounded¶

class torchrl.data.Bounded(*args, **kwargs)[源代码]¶

有界张量规范。

Bounded 规范永远不会以这种形式出现，并且始终被子类化为 BoundedContinuous 或 BoundedDiscrete，具体取决于它们的数据类型（浮点数据类型将导致 BoundedContinuous 实例，所有其他数据类型将导致 BoundedDiscrete 实例）。

参数:

low (np.ndarray, torch.Tensor 或 number) – 框的下界。
high (np.ndarray, torch.Tensor 或 number) – 框的上界。
shape (torch.Size) – Bounded 规范的形状。必须指定形状。输入 low、high 和 shape 必须是可广播的。
device (str, int 或 torch.device, optional) – 张量的设备。
dtype (str 或 torch.dtype, optional) – 张量的数据类型。
domain (str) – “continuous” 或 “discrete”。可用于覆盖自动类型分配。

示例

>>> spec = Bounded(low=-1, high=1, shape=(), dtype=torch.float)
>>> spec
BoundedContinuous(
    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 = Bounded(low=-1, high=1, shape=(), dtype=torch.int)
>>> spec
BoundedDiscrete(
    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)
BoundedContinuous(
    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 = Bounded(low=-1, high=1, shape=(), dtype=torch.int, domain="continuous")
>>> spec
BoundedContinuous(
    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() → Bounded[源代码]¶: 创建 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, optional) – 如果为 True，则会忽略规范设备。这用于将张量转换分组到 TensorDict(..., device="cuda") 的调用中，这样会更快。
返回:: 与所需张量规范匹配的 torch.Tensor。

expand(*shape)[源代码]¶

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

参数:: *shape (tuple 或 iterable of 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[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) – 填充 1 的张量的形状
返回:: 在 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)[source]¶

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

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

参数:: dim (int 或 None) – 要应用 squeeze 操作的维度

to(dest: Union[dtype, device, str, int]) → Bounded[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)[source]¶

返回一个新的 Spec，其中增加了一个单位维度（在 dim 指示的位置）。

参数:: dim (int 或 None) – 应用unsqueeze操作的维度。

view(*shape) → T¶

重塑 TensorSpec。

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

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

返回盒子中的零填充张量。

注意

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

参数:: shape (torch.Size) – 零张量的形状
返回:: 在 TensorSpec 盒子中采样的零填充张量。

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶: 代理到 zero()。

Bounded¶

文档

教程

资源