MultiOneHot

类 torchrl.data.MultiOneHot(nvec: Sequence[int], shape: Optional[torch.Size] = None, device=None, dtype=torch.bool, use_register=False, mask: torch.Tensor | None = None)

一个独热离散张量规范的串联。

当单个张量必须携带关于多个独热编码值的信息时，可以使用此类。

形状的最后一个维度（张量元素的域）不能被索引。

参数:

• nvec (整数可迭代对象) – 张量每个元素的基数。

• shape (torch.Size, 可选) – 采样张量的总形状。如果提供，最后一个维度必须与 sum(nvec) 匹配。

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

• dtype (str 或 torch.dtype, 可选) – 张量的数据类型（dtype）。

• mask (torch.Tensor 或 None) – 在采样时屏蔽一些可能的结果。有关详细信息，请参见 update_mask()。

示例

>>> ts = MultiOneHot((3,2,3))
>>> ts.rand()
tensor([ True, False, False,  True, False, False, False,  True])
>>> ts.is_in(torch.tensor([
...     0, 0, 1,
...     0, 1,
...     1, 0, 0], dtype=torch.bool))
True
>>> ts.is_in(torch.tensor([
...     1, 0, 1,
...     0, 1,
...     1, 0, 0], dtype=torch.bool))
False

assert_is_in(value: Tensor) → None

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

参数:

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

cardinality() → int

规范的基数（cardinality）。

这指的是规范中可能结果的数量。复合规范的基数被假定为所有可能结果的笛卡尔积。

clear_device_() → T

对于所有叶规范（必须有设备），这是一个无操作（no-op）。

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

clone() → MultiOneHot

创建 TensorSpec 的副本。

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

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

有关详细信息，请参见 is_in()。

cpu()

将 TensorSpec 转换为 'cpu' 设备。

cuda(device=None)

将 TensorSpec 转换为 'cuda' 设备。

device: torch.device | None = None

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

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

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

参数:

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

关键字参数:

ignore_device (bool, 可选) – 如果为 True，则将忽略规范的设备。这用于将张量转换集中在调用 TensorDict(..., device="cuda") 中，这样速度更快。

返回值:

符合所需张量规范的 torch.Tensor。

enumerate() → Tensor

返回可从 TensorSpec 中获得的所有样本。

样本将沿第一个维度堆叠。

此方法仅针对离散规范实现。

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 函数重写。

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

对输入张量进行索引。

此方法用于编码一个或多个分类变量（例如，OneHot 或 Categorical）的规范，以便可以使用样本对张量进行索引，而无需关心索引的实际表示形式。

参数:

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

• tensor_to_index – 要被索引的张量

返回值:

被索引的张量

示例

>>> from torchrl.data import OneHot
>>> import torch
>>>
>>> one_hot = OneHot(n=100)
>>> categ = one_hot.to_categorical_spec()
>>> idx_one_hot = torch.zeros((100,), dtype=torch.bool)
>>> idx_one_hot[50] = 1
>>> print(one_hot.index(idx_one_hot, torch.arange(100)))
tensor(50)
>>> idx_categ = one_hot.to_categorical(idx_one_hot)
>>> print(categ.index(idx_categ, torch.arange(100)))
tensor(50)

is_in(val: Tensor) → bool

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

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

参数:

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

返回值:

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

make_neg_dim(dim: int) → T

将特定维度转换为 -1。

property ndim: int

规范形状的维度数。

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

ndimension() → int

规范形状的维度数。

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

one(shape: torch.Size = None) → torch.Tensor | TensorDictBase

返回框中填充了 1 的张量。

注意

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

参数:

shape (torch.Size) – 填充 1 的张量的形状

返回值:

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

ones(shape: torch.Size = None) → torch.Tensor | TensorDictBase

one() 的代理。

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

如果输入张量不在 TensorSpec 框中，则根据某些定义的启发式方法将其映射回框中。

参数:

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

返回值:

属于 TensorSpec 框的 torch.Tensor。

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

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

采样将均匀地在空间上进行，除非框是无界的，在这种情况下将绘制正态分布的值。

参数:

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

返回值:

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

reshape(*shape) → T

重塑一个 TensorSpec。

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

sample(shape: torch.Size = None) → torch.Tensor | TensorDictBase

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

详情请参阅 rand()。

squeeze(dim=None)

返回一个新的规范（Spec），该规范移除了所有大小为 1 的维度。

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

参数:

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

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

将 TensorSpec 转换为指定的设备或数据类型。

如果未做任何更改，则返回相同的规范。

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

将给定的独热张量转换为分类格式。

参数:

• val (torch.Tensor, optional) – 要转换为分类格式的独热张量。

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

返回值:

分类张量。

示例

>>> mone_hot = MultiOneHot((2, 3, 4))
>>> onehot_sample = mone_hot.rand()
>>> onehot_sample
tensor([False,  True, False, False,  True, False,  True, False, False])
>>> categ_sample = mone_hot.to_categorical(onehot_sample)
>>> categ_sample
tensor([1, 2, 1])

to_categorical_spec() → MultiCategorical

将规范转换为等效的分类规范。

示例

>>> mone_hot = MultiOneHot((2, 3, 4))
>>> categ = mone_hot.to_categorical_spec()
>>> categ
MultiCategorical(
    shape=torch.Size([3]),
    space=BoxList(boxes=[CategoricalBox(n=2), CategoricalBox(n=3), CategoricalBox(n=4)]),
    device=cpu,
    dtype=torch.int64,
    domain=discrete)

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

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

这旨在作为 encode() 的逆操作。

参数:

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

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

返回值:

一个 np.ndarray。

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

对 MultiOneHot 无操作（No-op）。

to_one_hot_spec() → OneHot

对 MultiOneHot 无操作（No-op）。

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

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

参数:

• value (torch.Tensor) – 需要检查数据类型的张量。

• key (str, optional) – 如果 TensorSpec 包含键，则将根据指定键指向的规范检查值的数据类型。

unflatten(dim: int, sizes: Tuple[int]) → T

取消展平（Unflattens）一个 TensorSpec。

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

unsqueeze(dim: int)

返回一个新的规范（Spec），并在 dim 指定的位置增加一个单例维度。

参数:

dim (int 或 None) – 应用扩展（unsqueeze）操作的维度。

update_mask(mask)

设置一个掩码，以防止在采样时出现某些可能的结果。

也可以在初始化规范时设置掩码。

参数:

mask (torch.Tensor 或 None) – 布尔掩码。如果为 None，则禁用掩码。否则，掩码的形状必须可以扩展到规范的形状。False 屏蔽一个结果，True 使结果不被屏蔽。如果所有可能的结果都被屏蔽，则在采样时会引发错误。

示例

>>> mask = torch.tensor([True, False, False,
...                      True, True])
>>> ts = MultiOneHot((3, 2), (2, 5), dtype=torch.int64, mask=mask)
>>> # All but one of the three possible outcomes for the first
>>> # one-hot group are masked, but neither of the two possible
>>> # outcomes for the second one-hot group are masked.
>>> ts.rand()
tensor([[1, 0, 0, 0, 1],
        [1, 0, 0, 1, 0]])

view(*shape) → T

重塑一个 TensorSpec。

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

zero(shape: torch.Size = None) → torch.Tensor | TensorDictBase

返回一个在盒内填充零的张量。

注意

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

参数:

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

返回值:

一个在 TensorSpec 盒内采样的零填充张量。

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase

zero() 的代理。