Categorical

class torchrl.data.Categorical(n: int, shape: torch.Size | None = None, device: DEVICE_TYPING | None = None, dtype: str | torch.dtype = torch.int64, mask: torch.Tensor | None = None)

一种离散张量规范。

TorchRL 中分类变量的 OneHot 的替代方案。分类变量执行索引而不是掩码，这可以加快大型分类变量的计算速度并降低内存成本。

此规范将具有由 shape 参数定义的形状：如果希望训练维度采用单例维度，则应明确指定。

变量：

• n (int) – 可能结果的数量。

• shape (torch.Size) – 变量的形状。

• device (torch.device) – 张量所在的设备。

• dtype (torch.dtype) – 张量的数据类型。

参数：

• n (int) – 可能结果的数量。如果设置为 -1，则分类规范的基数未定义，必须在此规范采样之前调用 set_provisional_n。

• shape – (torch.Size, optional): 变量的形状，默认为 “torch.Size([])”。

• device (str, int 或 torch.device, optional) – 张量所在的设备。

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

• mask (torch.Tensor 或 None) – 一个布尔掩码，用于在采样时阻止某些可能结果。有关更多信息，请参阅 update_mask()。

示例

>>> categ = Categorical(3)
>>> categ
Categorical(
    shape=torch.Size([]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.int64,
    domain=discrete)
>>> categ.rand()
tensor(2)
>>> categ = Categorical(3, shape=(1,))
>>> categ
Categorical(
    shape=torch.Size([1]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.int64,
    domain=discrete)
>>> categ.rand()
tensor([1])
>>> categ = Categorical(-1)
>>> categ.set_provisional_n(5)
>>> categ.rand()
tensor(3)

注意

当 n 设置为 -1 时，如果在未先使用 set_provisional_n 设置临时 n 的情况下调用 rand，将引发 RuntimeError。

assert_is_in(value: Tensor) → None

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

参数：

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

cardinality() → int

规范的基数。

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

clear_device_() → T

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

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

clone() → Categorical

创建 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, optional) – 如果为 True，将忽略规范设备。这用于在调用 TensorDict(..., device="cuda") 时分组张量转换，这样速度更快。

返回：

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

enumerate() → Tensor

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

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

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

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 函数覆盖。

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

索引输入张量。

此方法用于编码一个或多个分类变量的规范（例如，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 属于规范域，当此条件违反时，此方法也不会引发异常。one 的主要用例是生成空数据缓冲区，而不是有意义的数据。

参数：

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

返回：

在 TensorSpec 范围中采样的填充一的张量。

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

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

详见 rand()。

set_provisional_n(n: int)

临时设置 Categorical 规范的基数。

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

参数：

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

squeeze(dim=None)

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

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

参数：

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

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

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

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

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

对于 categorical 是空操作。

to_categorical_spec() → Categorical

对于 categorical 是空操作。

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) → Tensor

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

参数：

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

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

返回：

one-hot 编码后的张量。

示例

>>> categ = Categorical(3)
>>> categ_sample = categ.zero()
>>> categ_sample
tensor(0)
>>> onehot_sample = categ.to_one_hot(categ_sample)
>>> onehot_sample
tensor([ True, False, False])

to_one_hot_spec() → OneHot

将规范转换为等效的 one-hot 规范。

示例

>>> categ = Categorical(3)
>>> categ.to_one_hot_spec()
OneHot(
    shape=torch.Size([3]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

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

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

参数：

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

• key (str, 可选) – 如果 TensorSpec 具有键，则将根据指示键指向的规范来检查值的 dtype。

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

解除展平 TensorSpec。

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

unsqueeze(dim: int)

返回一个新的 Spec，它增加了一个大小为 1 的维度（位于由 dim 指示的位置）。

参数：

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

update_mask(mask)

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

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

参数：

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

示例

>>> mask = torch.tensor([True, False, True])
>>> ts = Categorical(3, (10,), dtype=torch.int64, mask=mask)
>>> # One of the three possible outcomes is masked
>>> ts.rand()
tensor([0, 2, 2, 0, 2, 0, 2, 2, 0, 2])

view(*shape) → T

重塑 TensorSpec。

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

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

返回在 box 中填充零的张量。

注意

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

参数：

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

返回：

一个在 TensorSpec box 中采样的填充零的张量。

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

zero() 的代理。