MultiOneHot¶

class torchrl.data.MultiOneHot(nvec: Sequence[int], shape: Optional[Size] = None, device=None, dtype=torch.bool, use_register=False, mask: Optional[Tensor] = None)[source]¶

单热离散张量规格的串联。

当单个张量必须携带关于多个单热编码值的信息时，可以使用此类。

形状的最后一个维度（张量元素的域）不能被索引。

参数:

nvec (整数的可迭代对象) – 张量每个元素的基数。
shape (torch.Size, 可选) – 采样张量的总形状。如果提供，则最后一个维度必须与 sum(nvec) 匹配。
device (str, int 或 torch.device, 可选) – 张量的设备。
dtype (str 或 torch.dtype, 可选) – 张量的数据类型。
mask (torch.Tensor 或 None) – 采样时屏蔽一些可能的结果。有关更多信息，请参阅 update_mask()。

示例

>>> ts = MultiOneHot((3,2,3))
>>> ts.rand()
tensor([ True, False, False,  True, False, False, False,  True])
>>> ts.is_in(torch.tensor([
...     0, 0, 1,
...     0, 1,
...     1, 0, 0], dtype=torch.bool))
True
>>> ts.is_in(torch.tensor([
...     1, 0, 1,
...     0, 1,
...     1, 0, 0], dtype=torch.bool))
False

assert_is_in(value: Tensor) → None¶

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

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

clear_device_() → T¶

所有叶规格的无操作（必须具有设备）。

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

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

contains(item: torch.Tensor | tensordict.base.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[source]¶

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

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

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

expand(*shape)[source]¶

返回具有扩展形状的新 Spec。

参数:: *shape (tuple 或 整数的可迭代对象) – 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[source]¶

索引输入张量。

参数:

index (int, torch.Tensor, slice 或 list) – 张量的索引
tensor_to_index – 要索引的张量

返回:

索引张量

is_in(val: Tensor) → bool[source]¶

如果值 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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶

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

注意

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

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

ones(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶: 代理到 one()。

project(val: torch.Tensor | tensordict.base.TensorDictBase) → torch.Tensor | tensordict.base.TensorDictBase¶

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

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

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

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

除非框是无界的，否则将在空间上均匀完成采样，在这种情况下将绘制正态值。

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

reshape(*shape) → T¶

重塑 TensorSpec。

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

sample(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶

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

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

squeeze(dim=None)[source]¶

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

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

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

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

将 TensorSpec 转换为设备或数据类型。

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

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

将给定的 one-hot 张量转换为类别格式。

参数:

val (torch.Tensor, optional) – 要转换为类别格式的 one-hot 张量。
safe (bool) – 布尔值，指示是否应根据 spec 的域对值执行检查。默认为 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[source]¶

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

示例

>>> 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) – 布尔值，指示是否应根据 spec 的域对值执行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回:

一个 np.ndarray。

to_one_hot(val: Tensor, safe: Optional[bool] = None) → Tensor[source]¶: 对于 MultiOneHot，此操作为空操作。

to_one_hot_spec() → OneHot[source]¶: 对于 MultiOneHot，此操作为空操作。

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

根据 TensorSpec dtype 检查输入值 dtype，如果它们不匹配，则引发异常。

参数:

value (torch.Tensor) – 要检查 dtype 的张量。
key (str, optional) – 如果 TensorSpec 具有键，则将根据指示键指向的 spec 检查值 dtype。

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

展开 TensorSpec。

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

unsqueeze(dim: int)[source]¶

返回一个新的 Spec，其在 dim 指示的位置增加一个单例维度。

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

update_mask(mask)[source]¶

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

掩码也可以在 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: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶

返回框中的零填充张量。

注意

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

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

zeros(shape: Optional[Size] = None) → torch.Tensor | tensordict.base.TensorDictBase¶: 代理到 zero()。

MultiOneHot¶

文档

教程

资源