MultiOneHotDiscreteTensorSpec

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

一组 one-hot 离散张量规范的连接。

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

参数：

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

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

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

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

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

示例

>>> ts = MultiOneHotDiscreteTensorSpec((3,2,3))
>>> ts.is_in(torch.tensor([0,0,1,
...                        0,1,
...                        1,0,0]))
True
>>> ts.is_in(torch.tensor([1,0,1,
...                        0,1,
...                        1,0,0])) # False
False

assert_is_in(value: Tensor) → None

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

参数：

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

clear_device_()

对于所有叶子规范（必须具有设备）而言，这是一个无操作函数。

contains(item)

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

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

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

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

参数：

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

关键字参数：

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

返回值：

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

expand(*shape)

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

参数：

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

flatten(start_dim, end_dim)

展平一个张量规范。

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

classmethod implements_for_spec(torch_function: Callable) → Callable

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

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: Optional[Size] = None) → Tensor

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

参数：

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

返回值：

在 TensorSpec 范围内采样的随机张量。

reshape(*shape)

重塑张量规范。

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

property sample

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

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

squeeze(dim=None)

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

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

参数：

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

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

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

参数：

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

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

返回值：

分类张量。

to_categorical_spec() → MultiDiscreteTensorSpec

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

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)

展开张量规范。

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

update_mask(mask)

设置掩码以在获取样本时阻止某些可能的结果。

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

参数：

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

示例

>>> mask = torch.tensor([True, False, False,
...                      True, True])
>>> ts = MultiOneHotDiscreteTensorSpec((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)

重塑张量规范。

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

zero(shape=None) → Tensor

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

参数：

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

返回值：

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