OneHot¶

class torchrl.data.OneHot(n: int, shape: Optional[torch.Size] = None, device: Optional[DEVICE_TYPING] = None, dtype: Optional[Union[str, torch.dtype]] = torch.bool, use_register: bool = False, mask: torch.Tensor | None = None)[source]¶

一个一维的独热离散张量规范。

默认情况下，TorchRL 假定分类变量被编码为变量的独热编码。这使得对张量进行简单的索引成为可能，例如：

>>> batch, size = 3, 4
>>> action_value = torch.arange(batch*size)
>>> action_value = action_value.view(batch, size).to(torch.float)
>>> action = (action_value == action_value.max(-1,
...    keepdim=True)[0]).to(torch.long)
>>> chosen_action_value = (action * action_value).sum(-1)
>>> print(chosen_action_value)
tensor([ 3.,  7., 11.])

形状的最后一个维度（变量域）无法索引。

参数：

n (int) – 可能结果的数量。
shape (torch.Size, 可选) – 采样张量的总形状。如果提供，最后一个维度必须与 n 匹配。
device (str, int 或 torch.device, 可选) – 张量的设备。
dtype (str 或 torch.dtype, 可选) – 张量的数据类型。
use_register (bool) – 实验性功能。如果为 True，则每个整数将按照出现的顺序映射到一个二进制向量。此功能专为事先未定义可能结果数量的环境设计（例如，离散结果从任意集合中采样，其元素将在寄存器中映射到一系列唯一的独热二进制向量）。
mask (torch.Tensor 或 None) – 在采样时屏蔽部分可能的结果。有关更多信息，请参阅 update_mask()。

示例

>>> from torchrl.data.tensor_specs import OneHot
>>> spec = OneHot(5, shape=(2, 5))
>>> spec.rand()
tensor([[False,  True, False, False, False],
        [False,  True, False, False, False]])
>>> mask = torch.tensor([
... [False, False, False, False, True],
... [False, False, False, False, True]
... ])
>>> spec.update_mask(mask)
>>> spec.rand()
tensor([[False, False, False, False,  True],
        [False, False, False, False,  True]])

assert_is_in(value: Tensor) → None¶ 断言张量是否属于该范围，否则引发异常。

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

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

cardinality() → int[source]¶ 规范的基数。

规范的基数。

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

clear_device_() → T¶ 对于所有叶子规范（必须有设备）来说，这是无操作的。

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

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

clone() → OneHot[source]¶ 创建 TensorSpec 的副本。: 创建 TensorSpec 的副本。

contains(item: torch.Tensor | TensorDictBase) → bool¶ 如果值 val 可以由 TensorSpec 生成，则返回 True，否则返回 False。

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

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

cpu()¶ 将 TensorSpec 转换为 ‘cpu’ 设备。: 将 TensorSpec 转换为 ‘cpu’ 设备。

cuda(device=None)¶ 将 TensorSpec 转换为 ‘cuda’ 设备。: 将 TensorSpec 转换为 ‘cuda’ 设备。

device: torch.device | None = None¶

encode(val: Union[ndarray, Tensor], space: Optional[CategoricalBox] = None, *, ignore_device: bool = False) → Tensor[source]¶ 根据指定的规范对值进行编码，并返回相应的张量。

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

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

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

enumerate() → Tensor[source]¶ 返回可以从 TensorSpec 获取的所有样本。

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

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

此方法仅适用于离散规范。

expand(*shape)[source]¶ 返回具有扩展形状的新规范。

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

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

flatten(start_dim: int, end_dim: int) → T¶ 展平 TensorSpec。

展平 TensorSpec。

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

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

index(index: Union[int, Tensor, ndarray, slice, List], tensor_to_index: Tensor) → Tensor[source]¶ 对输入张量进行索引。

对输入张量进行索引。

此方法用于编码一个或多个分类变量的规范（例如，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[source]¶ 更准确地说，is_in 方法检查值 val 是否在由 space 属性（即范围）定义的范围内，并且 dtype、device、shape 以及可能的其他元数据是否与规范的相匹配。如果其中任何一个检查失败，is_in 方法将返回 False。

如果值 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。: 将特定维度转换为 -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() 的代理。: one() 的代理。

project(val: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase¶ 如果输入张量不在 TensorSpec 范围内，它会根据一些定义的启发式方法将其映射回去。

如果输入张量不在 TensorSpec 范围内，它会根据一些定义的启发式方法将其映射回去。

参数：: val (torch.Tensor) – 要映射到范围的张量。
返回：: 属于 TensorSpec 范围的 torch.Tensor。

rand(shape: Optional[Size] = None) → Tensor[source]¶ 在规范定义的空间中返回一个随机张量。

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

采样将在空间上均匀进行，除非范围是无界的，在这种情况下将抽取正态分布的值。

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

reshape(*shape) → T¶ 重塑 TensorSpec。

重塑 TensorSpec。

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

sample(shape: torch.Size = None) → torch.Tensor | TensorDictBase¶ 详细信息请参阅 rand()。

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

详细信息请参阅 rand()。

squeeze(dim=None)[source]¶

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

如果给定了 dim，则只在该维度上执行 squeeze 操作。

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

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

将 TensorSpec 转换为指定的 device 或 dtype。

如果未进行更改，则返回相同的 spec。

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

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

参数：

val (torch.Tensor, 可选) – 要转换为分类格式的一热张量。
safe (bool) – 布尔值，指示是否应根据 spec 的域对值执行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回：

分类张量。

示例

>>> one_hot = OneHot(3, shape=(2, 3))
>>> one_hot_sample = one_hot.rand()
>>> one_hot_sample
tensor([[False,  True, False],
        [False,  True, False]])
>>> categ_sample = one_hot.to_categorical(one_hot_sample)
>>> categ_sample
tensor([1, 1])

to_categorical_spec() → Categorical[source]¶

将 spec 转换为等效的分类 spec。

示例

>>> one_hot = OneHot(3, shape=(2, 3))
>>> one_hot.to_categorical_spec()
Categorical(
    shape=torch.Size([2]),
    space=CategoricalBox(n=3),
    device=cpu,
    dtype=torch.int64,
    domain=discrete)

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

返回输入张量对应的 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[source]¶: 对于 OneHot，这是一个无操作 (No-op)。

to_one_hot_spec() → OneHot[source]¶: 对于 OneHot，这是一个无操作 (No-op)。

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

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

参数：

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

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

对 TensorSpec 执行 unflatten 操作。

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

unsqueeze(dim: int)[source]¶

返回一个新的 Spec，该 Spec 在指定位置 (dim) 增加一个大小为 1 的维度。

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

update_mask(mask)[source]¶

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

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

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

示例

>>> mask = torch.tensor([True, False, False])
>>> ts = OneHot(3, (2, 3,), dtype=torch.int64, mask=mask)
>>> # All but one of the three possible outcomes are masked
>>> ts.rand()
tensor([[1, 0, 0],
        [1, 0, 0]])

view(*shape) → T¶

重塑 TensorSpec。

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

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

返回一个在框内的全零张量。

注意

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

参数：: shape (torch.Size) – 零张量的形状
返回：: 一个在 TensorSpec 框内采样的全零张量。

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

OneHot¶

文档

教程

资源