OneHotDiscreteTensorSpec

类 torchrl.data.OneHotDiscreteTensorSpec(*args, **kwargs)

已弃用的版本：torchrl.data.OneHot。

assert_is_in(value: Tensor) → None

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

参数：

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

cardinality() → int

Spec 的基数。

这指的是 Spec 中可能结果的数量。假设组合 Spec 的基数是所有可能结果的笛卡尔积。

clear_device_() → T

对所有叶子 Spec（必须有设备）而言是空操作 (no-op)。

对于 Composite Spec，此方法将擦除设备信息。

clone() → OneHot

创建一个 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: Union[ndarray, Tensor], space: Optional[CategoricalBox] = None, *, ignore_device: bool = False) → Tensor

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

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

参数：

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

关键字参数：

ignore_device (bool, optional) – 如果为 True，则忽略 spec 设备。这用于在调用 TensorDict(..., device="cuda") 时进行张量类型转换分组，这样更快。

返回：

匹配所需张量 specs 的 torch.Tensor。

enumerate() → Tensor

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

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

此方法仅针对离散型 Spec 实现。

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: Union[int, Tensor, ndarray, slice, List], tensor_to_index: Tensor) → Tensor

对输入张量进行索引。

此方法用于编码一个或多个分类变量（例如 OneHot 或 Categorical）的 specs，以便在对张量进行样本索引时，无需关注索引的实际表示形式。

参数：

• 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 以及潜在的其他元数据是否与 spec 的匹配。如果其中任何检查失败，is_in 方法将返回 False。

参数：

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

返回：

布尔值，指示值是否属于 TensorSpec 的范围。

make_neg_dim(dim: int) → T

将特定维度转换为 -1。

property ndim: int

Spec 形状的维度数。

len(spec.shape) 的快捷方式。

ndimension() → int

Spec 形状的维度数。

len(spec.shape) 的快捷方式。

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

返回范围内填充为 1 的张量。

注意

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

返回 spec 定义空间内的随机张量。

采样将在空间内均匀进行，除非范围无界，此时将抽取正态分布值。

参数：

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

返回：

在 TensorSpec 范围内采样的随机张量。

reshape(*shape) → T

重塑一个 TensorSpec。

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

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

返回 spec 定义空间内的随机张量。

详情请参见 rand()。

squeeze(dim=None)

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

当指定了 dim 时，仅在该维度上进行 squeeze 操作。

参数：

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

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

将 TensorSpec 转换为设备或 dtype。

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

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

将给定的独热 (one-hot) 张量转换为分类格式。

参数：

• val (torch.Tensor, optional) – 要转换为分类格式的独热张量。

• 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

将 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

返回输入张量对应的 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

对于 OneHot 而言是空操作 (No-op)。

to_one_hot_spec() → OneHot

对于 OneHot 而言是空操作 (No-op)。

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

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

参数：

• value (torch.Tensor) – 需要检查数据类型的张量。

• key (str, optional) – 如果 TensorSpec 包含键，则将根据指定键指向的规范来检查值的数据类型。

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

解除展平一个 TensorSpec。

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

unsqueeze(dim: int)

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

参数：

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

update_mask(mask)

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

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

参数：

mask (torch.Tensor or None) – 布尔型掩码。如果为 None，则禁用掩码。否则，掩码的形状必须能够扩展到规范的形状。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 属于规范域，当违反此条件时，此方法也不会引发异常。zero 的主要用例是生成空数据缓冲区，而不是有意义的数据。

参数：

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

返回：

一个在 TensorSpec 规范范围内采样的零值填充张量。

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

zero() 的代理。