MultiDiscreteTensorSpec

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

已弃用版本，替代为 torchrl.data.MultiCategorical。

assert_is_in(value: Tensor) → None

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

参数：

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

cardinality() → int

spec 的基数。

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

clear_device_() → T

对于所有叶子 spec（必须有 device），这是一个空操作。

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

clone() → MultiCategorical

创建 TensorSpec 的副本。

contains(item: torch.Tensor | TensorDictBase) → bool

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

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

cpu()

将 TensorSpec 转换为 'cpu' device。

cuda(device=None)

将 TensorSpec 转换为 'cuda' device。

device: torch.device | None = None

encode(val: np.ndarray | torch.Tensor | TensorDictBase, *, ignore_device: bool = False) → torch.Tensor | TensorDictBase

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

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

参数：

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

关键词参数：

ignore_device (bool, 可选) – 如果为 True，则忽略 spec 的 device。这用于在调用 TensorDict(..., device="cuda") 中对张量转换进行分组，这样更快。

返回：

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

enumerate() → Tensor

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

样本将沿第一维堆叠。

此方法仅为离散 spec 实现。

expand(*shape)

返回具有扩展 shape 的新 Spec。

参数：

*shape (tuple 或 int 的可迭代对象) – Spec 的新 shape。必须能与当前 shape 广播：其长度必须至少与当前 shape 长度相同，并且其最后的值也必须兼容；即，它们只能在当前维度为单例时与之不同。

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

对输入张量进行索引。

此方法用于编码一个或多个分类变量的 spec（例如，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 以及可能的其他元数据是否与 spec 的元数据匹配。如果任何检查失败，is_in 方法将返回 False。

参数：

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

返回：

布尔值，指示值是否属于 TensorSpec 框。

make_neg_dim(dim: int) → T

将指定维度转换为 -1。

property ndim: int

spec shape 的维度数。

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

ndimension() → int

spec shape 的维度数。

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

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

返回框中的全一张量。

注意

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

参数：

shape (torch.Size) – 全一张量的 shape

返回：

在 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) – 随机张量的 shape

返回：

在 TensorSpec 框中采样的随机张量。

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: int | None = None)

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

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

参数：

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

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

将 TensorSpec 转换为 device 或 dtype。

如果没有发生变化，则返回相同的 spec。

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

MultiCategorical 的非操作。

to_categorical_spec() → MultiCategorical

MultiCategorical 的非操作。

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) → Union[MultiOneHot, Tensor]

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

参数：

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

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

返回：

one-hot 编码后的张量。

to_one_hot_spec() → MultiOneHot

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

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)

返回一个新的 Spec，其中包含一个额外的单例维度 (位于 dim 指定的位置)。

参数：

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

update_mask(mask)

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

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

参数：

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

示例

>>> torch.manual_seed(0)
>>> mask = torch.tensor([False, False, True,
...                      True, True])
>>> ts = MultiCategorical((3, 2), (5, 2,), dtype=torch.int64, mask=mask)
>>> # All but one of the three possible outcomes for the first
>>> # group are masked, but neither of the two possible
>>> # outcomes for the second group are masked.
>>> ts.rand()
tensor([[2, 1],
        [2, 0],
        [2, 1],
        [2, 1],
        [2, 1]])

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() 的代理。