BinaryDiscreteTensorSpec¶

class torchrl.data.BinaryDiscreteTensorSpec(*args, **kwargs)[source]¶

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

assert_is_in(value: Tensor) → None¶

断言张量是否属于指定的范围（box），否则抛出异常。

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

cardinality() → int¶

spec 的基数（cardinality）。

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

clear_device_() → T¶

对所有叶子 spec（必须有 device）的无操作（no-op）。

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

clone() → Binary¶: 创建 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 (np.ndarray 或 torch.Tensor) – 要编码为张量的值。
关键字参数:: ignore_device (bool, optional) – 如果为 True，则将忽略 spec device。这用于在对 TensorDict(..., device="cuda") 的调用中对张量进行分组，这样更快。
返回:: 与所需张量 spec 匹配的 torch.Tensor。

enumerate() → Tensor¶

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

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

此方法仅针对离散 spec 实现。

expand(*shape)¶

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

参数:: *shape (tuple 或 iterable of 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¶

对输入张量进行索引。

此方法用于编码一个或多个分类变量的 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 属性（即 box）定义的范围内，并且 dtype、device、shape 以及可能的其他元数据是否与 spec 的元数据匹配。如果这些检查中有任何一个失败，is_in 方法将返回 False。

参数:: val (torch.Tensor) – 要检查的值。
返回:: 布尔值，指示值是否属于 TensorSpec box。

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¶

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

注意

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

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

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

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

如果输入张量不在 TensorSpec box 中，则根据一些已定义的启发式方法将其映射回 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]) → Binary¶

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

将 spec 域中的离散张量编码为其对应的独热（one-hot）张量。

参数:

val (torch.Tensor, optional) – 要进行独热编码的张量。
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¶

将 spec 转换为等效的独热 spec。

示例

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

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

参数:

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

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

对 TensorSpec 进行 unflatten 操作。

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

unsqueeze(dim: int)¶

返回一个新的 Spec，该 Spec 增加了一个大小为 1 的维度（位于 dim 指示的位置）。

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

update_mask(mask)¶

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

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

参数:: mask (torch.Tensor or None) – 布尔型掩码。如果为 None，则禁用掩码。否则，掩码的形状必须可扩展到等效独热 spec 的形状。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¶

返回 Box 中一个填充了零的张量。

注意

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

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

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

BinaryDiscreteTensorSpec¶

文档

教程

资源