MultiCategorical

class torchrl.data.MultiCategorical(nvec: Union[Sequence[int], Tensor, int], shape: Optional[Size] = None, device: Optional[Union[device, str, int]] = None, dtype: Optional[Union[str, dtype]] = torch.int64, mask: Optional[Tensor] = None, remove_singleton: bool = True)

离散张量规范的串联。

参数:

• nvec (整数的可迭代对象 或 torch.Tensor) – 张量每个元素的基数。可以有多个轴。

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

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

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

• remove_singleton (bool, 可选) – 如果 True，则将挤压单例样本（大小为 [1]）。默认为 True。

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

示例

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

assert_is_in(value: Tensor) → None

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

参数:

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

clear_device_() → T

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

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

clone() → MultiCategorical

创建 TensorSpec 的副本。

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

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

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

cpu()

将 TensorSpec 转换为 ‘cpu’ 设备。

cuda(device=None)

将 TensorSpec 转换为 ‘cuda’ 设备。

device: torch.device | None = None

encode(val: numpy.ndarray | torch.Tensor | tensordict.base.TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | tensordict.base.TensorDictBase

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

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

参数:

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

关键字参数:

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

返回:

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

expand(*shape)

返回具有扩展形状的新 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

如果值 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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase

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

注意

即使不能保证 1 属于规范域，但当违反此条件时，此方法也不会引发异常。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

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

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

参数:

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

返回:

在 TensorSpec 空间中采样的随机张量。

reshape(*shape) → T

重塑 TensorSpec。

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

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

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

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

squeeze(dim: Optional[int] = None)

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

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

参数:

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

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

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

如果没有更改，则返回相同的规范。

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

MultiCategorical 的非操作。

to_categorical_spec() → MultiCategorical

MultiCategorical 的非操作。

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

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

此方法旨在作为 encode() 的逆运算。

参数:

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

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

返回:

一个 np.ndarray。

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

将 spec 域中的离散张量编码为其 one-hot 对应形式。

参数:

• val (torch.Tensor, optional) – 要进行 one-hot 编码的张量。

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

返回:

one-hot 编码后的张量。

to_one_hot_spec() → MultiOneHot

将 spec 转换为等效的 one-hot spec。

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

根据 TensorSpec dtype 检查输入值 dtype，如果它们不匹配，则引发异常。

参数:

• value (torch.Tensor) – 要检查 dtype 的张量。

• key (str, optional) – 如果 TensorSpec 具有键，则将根据指示键指向的 spec 检查值 dtype。

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

展开 TensorSpec。

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

unsqueeze(dim: int)

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

参数:

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

update_mask(mask)

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

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

参数:

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

示例

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

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()。