MultiCategorical¶

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

离散张量规范的串联。

参数:

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¶

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

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

cardinality() → int[source]¶

规范的基数。

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

clear_device_() → T¶

对所有叶子规范（必须有设备）来说是空操作。

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

clone() → MultiCategorical[source]¶: 创建 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: np.ndarray | torch.Tensor | TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | TensorDictBase¶

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

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

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

enumerate() → Tensor[source]¶

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

样本将沿第一维度堆叠。

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

expand(*shape)[source]¶

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

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

flatten(start_dim: int, end_dim: int) → T¶

展平 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable¶: 为 TensorSpec 注册一个 torch 函数覆盖。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase¶

对输入张量进行索引。

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

参数:

index (int, torch.Tensor, 切片或 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[source]¶

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

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

采样将均匀地分布在空间中，除非该范围无界，此时将抽取正态分布的值。

参数:: shape (torch.Size) – 随机张量的形状
返回值:: 在 TensorSpec 范围内采样的随机张量。

reshape(*shape) → T¶

重塑 TensorSpec。

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

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

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

详细信息请参阅 rand()。

set_provisional_n(n: int)¶

临时设置 Categorical 规范的基数。

当 n 为 -1 时，必须在从规范采样之前调用此方法。

参数:: n (int) – Categorical 规范的基数。

squeeze(dim: int | None = None)[source]¶

返回一个移除所有大小为 1 的维度的新规范。

当指定 dim 时，仅在该维度进行压缩操作。

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

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

将 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¶

返回输入 Tensor 对应的 np.ndarray。

这被认为是 encode() 操作的逆操作。

参数:

val (torch.Tensor) – 要转换为 numpy 的 Tensor。
safe (bool) – 布尔值，指示是否针对 spec 的域对值进行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回值:

一个 np.ndarray。

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

将 spec 域中的离散 Tensor 编码为其对应的独热 (one-hot) 表示。

参数:

val (torch.Tensor, optional) – 要进行独热编码的 Tensor。
safe (bool) – 布尔值，指示是否针对 spec 的域对值进行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回值:

独热编码后的 Tensor。

to_one_hot_spec() → MultiOneHot[源]¶: 将 spec 转换为等效的独热 spec。

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

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

参数:

value (torch.Tensor) – 需要检查 `dtype` 的 Tensor。
key (str, optional) – 如果 `TensorSpec` 包含键，则将根据指定键指向的 spec 检查值的 `dtype`。

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

对 TensorSpec 进行 unflatten 操作（逆展平）。

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

unsqueeze(dim: int)[源]¶

返回一个带有额外单维度的新 Spec（位于由 dim 指定的位置）。

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

update_mask(mask)[源]¶

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

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

参数:: mask (torch.Tensor or None) – 布尔掩码。如果为 None，则禁用掩码。否则，掩码的形状必须可以扩展到等效独热 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: torch.Size = None) → torch.Tensor | TensorDictBase¶

返回 spec 范围内的零填充 Tensor。

注意

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

参数:: shape (torch.Size) – 零 Tensor 的形状。
返回值:: 在 TensorSpec 范围内采样的零填充 Tensor。

zeros(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶: zero() 的代理。

MultiCategorical¶

文档

教程

资源