Binary¶

class torchrl.data.Binary(n: int | None = None, shape: Optional[torch.Size] = None, device: Optional[DEVICE_TYPING] = None, dtype: Union[str, torch.dtype] = torch.int8)[source]¶

一种二元离散张量规格（spec）。

二元张量规格（spec）编码任意大小的张量，其值只能是 0 或 1（如果 dtype 是 torch.bool，则为 True 或 False）。

与 OneHot 不同，Binary 在最后一个维度上可以有多个非空（non-null）元素。

参数：:

n (int) –
二元向量的长度。如果与 shape 同时提供，shape[-1] 必须与 n 匹配。如果未提供，则必须传入 shape。

警告

Binary 中的参数 n 不要与 Categorical 或 OneHot 中的参数 n 混淆，后者表示可采样的最大元素数量。为清晰起见，请改用 shape。
shape (torch.Size, 可选) – 采样张量的总形状。如果提供，最后一个维度必须与 n 匹配。
device (str, int 或 torch.device, 可选) – 张量的设备。
dtype (str 或 torch.dtype, 可选) – 张量的数据类型（dtype）。默认为 torch.int8。

示例

>>> torch.manual_seed(0)
>>> spec = Binary(n=4, shape=(2, 4))
>>> print(spec.rand())
tensor([[0, 1, 1, 0],
        [1, 1, 1, 1]], dtype=torch.int8)
>>> spec = Binary(shape=(2, 4))
>>> print(spec.rand())
tensor([[1, 1, 1, 0],
        [0, 1, 0, 0]], dtype=torch.int8)
>>> spec = Binary(n=4)
>>> print(spec.rand())
tensor([0, 0, 0, 1], dtype=torch.int8)

assert_is_in(value: Tensor) → None¶

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

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

cardinality() → int¶

该规格（spec）的基数。

这指的是一个规格中所有可能结果的数量。假定组合规格（composite spec）的基数是所有可能结果的笛卡尔积。

clear_device_() T¶

对所有叶子规格（leaf specs）来说是无操作（no-op）（叶子规格必须有设备）。

对于 Composite 规格（specs），此方法将擦除设备。

clone() → Binary[source]¶: 创建 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）编码值，并返回相应的张量。

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

参数：:: val (np.ndarray 或 torch.Tensor) – 要编码为张量的值。
关键字参数：:: ignore_device (bool, 可选) – 如果为 True，将忽略规格（spec）设备。这用于将张量类型转换（casting）分组到 TensorDict(..., device="cuda") 调用中，从而提高速度。
返回值：:: 与所需张量规格（specs）匹配的 torch.Tensor。

enumerate() → Tensor¶

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

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

此方法仅针对离散规格（discrete specs）实现。

expand(*shape)[source]¶

返回一个具有扩展形状的新规格（Spec）。

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

flatten(start_dim: int, end_dim: int) → T¶

展平（Flattens）一个 TensorSpec。

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

classmethod implements_for_spec(torch_function: Callable) → Callable¶: 为 TensorSpec 注册一个 torch 函数覆盖（override）。

index(index: INDEX_TYPING, tensor_to_index: torch.Tensor | TensorDictBase) → torch.Tensor | TensorDictBase¶

对输入张量进行索引。

此方法与编码一个或多个分类变量（categorical variables）（例如 OneHot 或 Categorical）的规格（specs）一起使用，以便在对张量进行索引时无需关心索引的实际表示形式。

参数：:

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 张量。

注意

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

参数：:: shape (torch.Size) – 全 1 张量的形状
返回值：:: 在 TensorSpec 范围（box）内采样的全 1 张量。

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

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

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

参数：:: val (torch.Tensor) – 要映射到该范围（box）的张量。
返回值：:: 属于 TensorSpec 范围（box）的 torch.Tensor。

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

返回该规格（spec）定义的空间中的随机张量。

采样将在该空间上均匀进行，除非范围（box）无界（unbounded），此时将抽取正态分布值。

参数：:: shape (torch.Size) – 随机张量的形状
返回值：:: 在 TensorSpec 范围（box）内采样的随机张量。

reshape(*shape) → T¶

重塑（Reshapes）一个 TensorSpec。

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

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

返回该规格（spec）定义的空间中的随机张量。

详见 rand() 的说明。

set_provisional_n(n: int)¶

临时设置 Categorical 规格（spec）的基数（cardinality）。

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

参数：:: n (int) – Categorical 规格（spec）的基数（cardinality）。

squeeze(dim=None)[源代码]¶

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

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

参数：:: dim (int or None) – 应用挤压操作的维度

to(dest: Union[dtype, device, str, int]) → Binary[源代码]¶

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

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

to_categorical(val: Tensor, safe: Optional[bool] = None) → Tensor¶: 对于 categorical，这是一个无操作。

to_categorical_spec() → Categorical¶: 对于 categorical，这是一个无操作。

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) – 要进行 one-hot 编码的张量。
safe (bool) – 布尔值，指示是否应对值与 spec 域进行检查。默认为 CHECK_SPEC_ENCODE 环境变量的值。

返回值：:

one-hot 编码后的张量。

示例

>>> 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 转换为等价的 one-hot 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¶

检查输入值的 dtype 是否与 TensorSpec 的 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 增加了一个单例维度（在由 dim 指示的位置）。

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

update_mask(mask)¶

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

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

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

重塑（Reshapes）一个 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() 的代理。

Binary¶

文档

教程

资源