Categorical¶

class torchrl.data.Categorical(n: int, shape: Optional[Size] = None, device: Optional[Union[device, str, int]] = None, dtype: str | torch.dtype = torch.int64, mask: Optional[Tensor] = None)[source]¶

离散张量规范。

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

该规范将具有由 shape 参数定义的形状：如果希望训练维度是单例维度，则应显式指定它。

参数:

n (int) – 可能结果的数量。
shape – (torch.Size, 可选): 变量的形状，默认为 “torch.Size([])”。
device (str, int 或 torch.device, 可选) – 张量的设备。
dtype (str 或 torch.dtype, 可选) – 张量的 dtype。
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])

assert_is_in(value: Tensor) → None¶

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

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

clear_device_() → T¶

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

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

clone() → Categorical[source]¶: 创建 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)[source]¶

返回具有扩展形状的新 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[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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶

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

注意

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

参数:: shape (torch.Size) – 1 张量的形状
返回:: 在 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[source]¶

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

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

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

reshape(*shape) → T¶

重塑 TensorSpec。

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

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

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

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

squeeze(dim=None)[source]¶

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

当给出 dim 时，仅在该维度上完成 squeeze 操作。

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

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

将 TensorSpec 转换为设备或 dtype。

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

to_categorical(val: Tensor, safe: Optional[bool] = None) → Tensor[source]¶: 分类的无操作。

to_categorical_spec() → Categorical[source]¶: 分类的无操作。

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

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

这旨在成为 encode() 的逆运算。

参数:

val (torch.Tensor) – 要转换为 numpy 的张量。
safe (bool) – 指示是否应根据规范域对值执行检查的布尔值。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回:

一个 np.ndarray。

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

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

参数:

val (torch.Tensor, optional) – 要进行 one-hot 编码的张量。
safe (bool) – 指示是否应根据规范域对值执行检查的布尔值。默认为 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[source]¶

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

示例

>>> 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, optional) – 如果 TensorSpec 具有键，则将根据指示键指向的 spec 检查值 dtype。

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

展平 TensorSpec。

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

unsqueeze(dim: int)[source]¶

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

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

update_mask(mask)[source]¶

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

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

参数:: mask (torch.Tensor 或 None) – 布尔掩码。如果为 None，则禁用掩码。否则，掩码的形状必须可扩展到等效 one-hot spec 的形状。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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶

返回框中填充零的张量。

注意

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

参数:: shape (torch.Size) – 零张量的形状
返回:: 在 TensorSpec 框中采样的填充零的张量。

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶: 代理到 zero()。

Categorical¶

文档

教程

资源