MultiOneHotDiscreteTensorSpec¶

类 torchrl.data.MultiOneHotDiscreteTensorSpec(*args, **kwargs)[源代码]¶

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

assert_is_in(value: Tensor) → None¶

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

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

cardinality() → int¶

规格的基数。

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

clear_device_() → T¶

对于所有叶子规格（必须有设备）来说是一个无操作 (no-op)。

对于 Composite 规格，此方法将清除设备。

clone() → MultiOneHot¶: 创建 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], *, ignore_device: bool = False) → Tensor¶

根据指定的规格编码一个值，并返回相应的张量。

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

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

enumerate() → Tensor¶

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

样本将沿第一维堆叠。

此方法仅针对离散规格实现。

expand(*shape)¶

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

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

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）的规格一起使用，以便可以在不关心索引的实际表示的情况下对张量进行索引。

参数：:

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 以及可能的其他元数据是否与规格的匹配。如果这些检查中的任何一个失败，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: torch.Size = None) → torch.Tensor | TensorDictBase¶

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

注意

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

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

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¶

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

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

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

reshape(*shape) → T¶

重塑 TensorSpec。

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

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

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

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

squeeze(dim=None)¶

返回一个新的规格，移除所有大小为 1 的维度。

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

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

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

将 TensorSpec 转换为设备或 dtype。

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

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

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

参数：:

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

返回：:

分类张量。

示例

>>> mone_hot = MultiOneHot((2, 3, 4))
>>> onehot_sample = mone_hot.rand()
>>> onehot_sample
tensor([False,  True, False, False,  True, False,  True, False, False])
>>> categ_sample = mone_hot.to_categorical(onehot_sample)
>>> categ_sample
tensor([1, 2, 1])

to_categorical_spec() → MultiCategorical¶

将规格转换为等效的分类规格。

示例

>>> mone_hot = MultiOneHot((2, 3, 4))
>>> categ = mone_hot.to_categorical_spec()
>>> categ
MultiCategorical(
    shape=torch.Size([3]),
    space=BoxList(boxes=[CategoricalBox(n=2), CategoricalBox(n=3), CategoricalBox(n=4)]),
    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) – 布尔值，指示是否应根据规格的域对值进行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回：:

一个 np.ndarray。

to_one_hot(val: Tensor, safe: Optional[bool] = None) → Tensor¶: MultiOneHot 的无操作 (No-op)。

to_one_hot_spec() → OneHot¶: MultiOneHot 的无操作 (No-op)。

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

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

参数：:

value (torch.Tensor) – 需要检查 dtype 的张量。
key (str, 可选) – 如果 TensorSpec 具有键，则将对照由指定键指向的规格检查值的 dtype。

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

取消展平 TensorSpec。

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

unsqueeze(dim: int)¶

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

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

update_mask(mask)¶

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

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

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

示例

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

view(*shape) → T¶

重塑 TensorSpec。

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

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

返回 Spec 中填充零的张量。

注意

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

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

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

MultiOneHotDiscreteTensorSpec¶

文档

教程

资源