DiscreteTensorSpec

class torchrl.data.DiscreteTensorSpec(*args, **kwargs)

torchrl.data.Categorical 的已弃用版本。

assert_is_in(value: Tensor) → None

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

参数：

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

cardinality() → int

此 spec 的基数。

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

clear_device_() → T

对于所有叶子 spec（必须有设备），此方法是空操作（no-op）。

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

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

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

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

参数：

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

关键字参数：

ignore_device (bool, 可选) – 如果为 True，将忽略 spec 设备。这用于将张量转换分组在 TensorDict(..., device="cuda") 调用内，后者速度更快。

返回：

与所需张量 spec 匹配的 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: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase

索引输入张量。

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

参数：

• 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 属性（即范围 box）定义的限制内，并且 dtype、device、shape 以及其他可能的元数据与 spec 的匹配。如果任何这些检查失败，is_in 方法将返回 False。

参数：

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

返回：

一个布尔值，指示值是否属于 TensorSpec 范围（box）。

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

返回范围（box）内填充为一的张量。

注意

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

参数：

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

返回：

在 TensorSpec 范围（box）内采样的填充为一的张量。

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

one() 的代理方法。

project(val: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase

如果输入张量不在 TensorSpec 范围（box）内，则根据某些已定义的启发式方法将其映射回该范围。

参数：

val (torch.Tensor) – 要映射到范围（box）的张量。

返回：

一个属于 TensorSpec 范围（box）的 torch.Tensor。

rand(shape: Optional[Size] = None) → Tensor

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

采样将在空间内均匀进行，除非范围（box）无界，在这种情况下将抽取正态值。

参数：

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

返回：

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

reshape(*shape) → T

重塑 TensorSpec。

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

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

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

详情请参阅 rand()。

set_provisional_n(n: int)

临时设置 Categorical spec 的基数。

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

参数：

n (int) – Categorical spec 的基数。

squeeze(dim=None)

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

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

参数：

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

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

将 TensorSpec 转换为设备或 dtype。

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

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

对 categorical 是空操作（no-op）。

to_categorical_spec() → Categorical

对 categorical 是空操作（no-op）。

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

将规范域中的离散张量编码为其对应的独热形式。

参数：

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

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

返回：

独热编码后的张量。

示例

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

将此规范转换为等价的独热规范。

示例

>>> 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) – 需要检查数据类型的张量。

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

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

对 TensorSpec 进行解除展平操作。

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

unsqueeze(dim: int)

返回一个新的 Spec，其中增加一个单一维度（位于 dim 指定的位置）。

参数：

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

update_mask(mask)

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

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

参数：

mask (torch.Tensor 或 None) – 布尔型掩码。如果为 None，则禁用掩码。否则，掩码的形状必须能够扩展到等价的独热规范的形状。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

返回规范域中填充零的张量。

注意

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

参数：

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

返回：

在 TensorSpec 规范域中采样的填充零的张量。

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

zero() 的代理。