torch.masked¶

简介¶

动机¶

警告

掩码张量的 PyTorch API 处于原型阶段，未来可能会发生变化。

MaskedTensor 是 torch.Tensor 的扩展，它为用户提供了以下功能：

使用任何掩码语义（例如可变长度张量、nan* 运算符等）
区分 0 和 NaN 梯度
各种稀疏应用（参见下面的教程）

“指定”和“未指定”在 PyTorch 中有着悠久的历史，但没有正式的语义，当然也没有一致性；实际上，MaskedTensor 的诞生是由于 vanilla torch.Tensor 类无法解决的问题堆积而成的。因此，MaskedTensor 的主要目标是成为 PyTorch 中这些“指定”和“未指定”值的真实来源，在这里它们是第一公民，而不是事后的想法。反过来，这应该进一步释放稀疏性的潜力，使运算符更安全、更一致，并为用户和开发者提供更流畅、更直观的体验。

什么是 MaskedTensor？¶

MaskedTensor 是一个张量子类，它由 1) 输入（数据）和 2) 掩码组成。掩码告诉我们应该包含或忽略输入中的哪些条目。

例如，假设我们想要屏蔽掉所有等于 0 的值（用灰色表示）并取最大值

顶部是 vanilla 张量示例，底部是 MaskedTensor，其中所有 0 都被屏蔽。这显然会导致不同的结果，具体取决于我们是否拥有掩码，但这种灵活的结构允许用户在计算过程中有系统地忽略他们想要的任何元素。

我们已经编写了一些教程来帮助用户入门，例如：

支持的运算符¶

一元运算符¶

一元运算符是只包含一个输入的运算符。将它们应用于 MaskedTensor 相对简单：如果数据在给定索引处被屏蔽，我们将应用运算符，否则我们将继续屏蔽数据。

可用的一元运算符为：

`abs`	计算 `input` 中每个元素的绝对值。
`absolute`	`torch.abs()` 的别名
`acos`	计算 `input` 中每个元素的反余弦。
`arccos`	`torch.acos()` 的别名。
`acosh`	返回一个新张量，其中包含 `input` 元素的反双曲余弦。
`arccosh`	`torch.acosh()` 的别名。
`angle`	计算给定 `input` 张量的逐元素角度（以弧度为单位）。
`asin`	返回一个新张量，其中包含 `input` 元素的反正弦。
`arcsin`	`torch.asin()` 的别名。
`asinh`	返回一个新张量，其中包含 `input` 元素的反双曲正弦。
`arcsinh`	`torch.asinh()` 的别名。
`atan`	返回一个新张量，其中包含 `input` 元素的反正切。
`arctan`	`torch.atan()` 的别名。
`atanh`	返回一个新张量，其中包含 `input` 元素的反双曲正切。
`arctanh`	`torch.atanh()` 的别名。
`bitwise_not`	计算给定输入张量的按位非运算。
`ceil`	返回一个新张量，其中包含 `input` 元素的上限，即大于或等于每个元素的最小整数。
`clamp`	将 `input` 中的所有元素夹在范围 [ `min`, `max` ] 之间。
`clip`	是 `torch.clamp()` 的别名。
`conj_physical`	计算给定 `input` 张量的元素级共轭。
`cos`	返回一个新张量，其中包含 `input` 元素的余弦。
`cosh`	返回一个新张量，其中包含 `input` 元素的双曲余弦。
`deg2rad`	返回一个新张量，其中包含 `input` 中每个元素从度数转换为弧度。
`digamma`	是 `torch.special.digamma()` 的别名。
`erf`	是 `torch.special.erf()` 的别名。
`erfc`	是 `torch.special.erfc()` 的别名。
`erfinv`	是 `torch.special.erfinv()` 的别名。
`exp`	返回一个新张量，其中包含输入张量 `input` 元素的指数。
`exp2`	是 `torch.special.exp2()` 的别名。
`expm1`	是 `torch.special.expm1()` 的别名。
`fix`	是 `torch.trunc()` 的别名。
`floor`	返回一个新张量，其中包含 `input` 元素的向下取整，即小于或等于每个元素的最大整数。
`frac`	计算 `input` 中每个元素的小数部分。
`lgamma`	计算 `input` 上伽马函数的绝对值的自然对数。
`log`	返回一个新张量，其中包含 `input` 元素的自然对数。
`log10`	返回一个新张量，其中包含 `input` 元素以 10 为底的对数。
`log1p`	返回一个新张量，其中包含 (1 + `input`) 的自然对数。
`log2`	返回一个新张量，其中包含 `input` 元素以 2 为底的对数。
`logit`	是 `torch.special.logit()` 的别名。
`i0`	是 `torch.special.i0()` 的别名。
`isnan`	返回一个新张量，其中包含布尔型元素，表示 `input` 的每个元素是否为 NaN。
`nan_to_num`	分别用 `nan`、`posinf` 和 `neginf` 指定的值替换 `NaN`、正无穷大和负无穷大值，这些值在 `input` 中。
`neg`	返回一个新张量，其中包含 `input` 元素的负值。
`negative`	是 `torch.neg()` 的别名。
`positive`	返回 `input`。
`pow`	用 `exponent` 对 `input` 中的每个元素求幂，并返回包含结果的张量。
`rad2deg`	返回一个新张量，其中包含 `input` 中每个元素从弧度转换为度数。
`reciprocal`	返回一个新张量，其中包含 `input` 元素的倒数。
`round`	将 `input` 的元素四舍五入到最接近的整数。
`rsqrt`	返回一个新张量，其中包含 `input` 中每个元素的平方根的倒数。
`sigmoid`	是 `torch.special.expit()` 的别名。
`sign`	返回一个新张量，其中包含 `input` 元素的符号。
`sgn`	此函数是 torch.sign() 的扩展，用于复数张量。
`signbit`	测试 `input` 的每个元素的符号位是否设置。
`sin`	返回一个新张量，其中包含 `input` 元素的正弦。
`sinc`	是 `torch.special.sinc()` 的别名。
`sinh`	返回一个新张量，其中包含 `input` 元素的双曲正弦。
`sqrt`	返回一个新张量，其中包含 `input` 元素的平方根。
`square`	返回一个新张量，其中包含 `input` 元素的平方。
`tan`	返回一个新张量，其中包含 `input` 元素的正切。
`tanh`	返回一个新张量，其中包含 `input` 元素的双曲正切。
`trunc`	返回一个新张量，其中包含 `input` 元素的截断整数值。

可用的就地一元运算符是以上所有运算符，除了

`angle`	计算给定 `input` 张量的逐元素角度（以弧度为单位）。
`positive`	返回 `input`。
`signbit`	测试 `input` 的每个元素的符号位是否设置。
`isnan`	返回一个新张量，其中包含布尔型元素，表示 `input` 的每个元素是否为 NaN。

二元运算符¶

正如您在教程中看到的，MaskedTensor 也实现了二元运算，但前提是两个 MaskedTensor 中的掩码必须匹配，否则将引发错误。如错误中所述，如果您需要支持特定运算符或对它们的行为方式提出语义建议，请在 GitHub 上提交一个 issue。目前，我们决定使用最保守的实现，以确保用户确切地知道发生了什么，并且对他们使用掩码语义的决定有意识。

可用的二元运算符是

`add`	将 `other`（乘以 `alpha`）添加到 `input` 中。
`atan2`	考虑象限的情况下， $\text{input}_{i} / \text{other}_{i}$ 的元素级反正切。
`arctan2`	是 `torch.atan2()` 的别名。
`bitwise_and`	计算 `input` 和 `other` 的按位与运算。
`bitwise_or`	计算 `input` 和 `other` 的按位或运算。
`bitwise_xor`	计算 `input` 和 `other` 的按位异或运算。
`bitwise_left_shift`	计算 `input` 左移 `other` 位。
`bitwise_right_shift`	计算 `input` 右移 `other` 位。
`div`	将输入 `input` 的每个元素除以 `other` 的对应元素。
`divide`	是 `torch.div()` 的别名。
`floor_divide`
`fmod`	逐元素应用 C++ 的 std::fmod。
`logaddexp`	输入的指数之和的对数。
`logaddexp2`	输入以 2 为底的指数之和的对数。
`mul`	将 `input` 乘以 `other`。
`multiply`	`torch.mul()` 的别名。
`nextafter`	返回 `input` 之后朝着 `other` 的下一个浮点数，按元素计算。
`remainder`	按元素计算 Python 的模运算。
`sub`	从 `input` 中减去 `other`，乘以 `alpha`。
`subtract`	`torch.sub()` 的别名。
`true_divide`	`torch.div()` 的别名，其中 `rounding_mode=None`。
`eq`	按元素计算相等性。
`ne`	按元素计算 $\text{input} \neq \text{other}$ 。
`le`	按元素计算 $\text{input} \leq \text{other}$ 。
`ge`	按元素计算 $\text{input} \geq \text{other}$ 。
`greater`	`torch.gt()` 的别名。
`greater_equal`	`torch.ge()` 的别名。
`gt`	按元素计算 $\text{input} > \text{other}$ 。
`less_equal`	`torch.le()` 的别名。
`lt`	按元素计算 $\text{input} < \text{other}$ 。
`less`	`torch.lt()` 的别名。
`maximum`	按元素计算 `input` 和 `other` 的最大值。
`minimum`	按元素计算 `input` 和 `other` 的最小值。
`fmax`	按元素计算 `input` 和 `other` 的最大值。
`fmin`	按元素计算 `input` 和 `other` 的最小值。
`not_equal`	`torch.ne()` 的别名。

可用的就地二元运算符是以上所有运算符，**除了**

`logaddexp`	输入的指数之和的对数。
`logaddexp2`	输入以 2 为底的指数之和的对数。
`equal`	如果两个张量大小和元素相同，则为 `True`，否则为 `False`。
`fmin`	按元素计算 `input` 和 `other` 的最小值。
`minimum`	按元素计算 `input` 和 `other` 的最小值。
`fmax`	按元素计算 `input` 和 `other` 的最大值。

聚合¶

以下聚合运算可用（支持自动微分）。有关更多信息，概述教程详细介绍了一些聚合运算的示例，而高级语义教程对我们如何决定某些聚合语义进行了更深入的讨论。

`sum`	返回 `input` 张量中所有元素的总和。
`mean`	返回 `input` 张量中所有元素的平均值。
`amin`	返回 `input` 张量在给定维度 `dim` 上每个切片的最小值。
`amax`	返回 `input` 张量在给定维度 `dim` 上每个切片的最大值。
`argmin`	返回扁平化张量或沿给定维度上的最小值的索引。
`argmax`	返回 `input` 张量中所有元素的最大值的索引。
`prod`	返回 `input` 张量中所有元素的乘积。
`all`	测试 `input` 中的所有元素是否都计算为 True。
`norm`	返回给定张量的矩阵范数或向量范数。
`var`	计算由 `dim` 指定的维度上的方差。
`std`	计算由 `dim` 指定的维度上的标准差。

视图和选择函数¶

我们还包含了许多视图和选择函数；直观地，这些运算符将应用于数据和掩码，然后将结果包装在一个 MaskedTensor 中。举个简单的例子，考虑 select()

>>> data = torch.arange(12, dtype=torch.float).reshape(3, 4)
>>> data
tensor([[ 0.,  1.,  2.,  3.],
        [ 4.,  5.,  6.,  7.],
        [ 8.,  9., 10., 11.]])
>>> mask = torch.tensor([[True, False, False, True], [False, True, False, False], [True, True, True, True]])
>>> mt = masked_tensor(data, mask)
>>> data.select(0, 1)
tensor([4., 5., 6., 7.])
>>> mask.select(0, 1)
tensor([False,  True, False, False])
>>> mt.select(0, 1)
MaskedTensor(
  [      --,   5.0000,       --,       --]
)

目前支持以下运算

`atleast_1d`	返回每个零维输入张量的 1 维视图。
`broadcast_tensors`	根据广播语义广播给定的张量。
`broadcast_to`	将 `input` 广播到形状 `shape`。
`cat`	在给定维度上连接给定的 `seq` 张量序列。
`chunk`	尝试将张量分割成指定数量的块。
`column_stack`	通过水平堆叠 `tensors` 中的张量来创建一个新的张量。
`dsplit`	根据 `indices_or_sections` 深度地将 `input`（一个具有三个或更多维度的张量）分割成多个张量。
`flatten`	通过将 `input` 重塑为一维张量来扁平化它。
`hsplit`	根据 `indices_or_sections` 水平地将 `input`（一个具有一个或多个维度的张量）分割成多个张量。
`hstack`	水平（按列）依次堆叠张量。
`kron`	计算 `input` 和 `other` 的克罗内克积，表示为 $\otimes$ 。
`meshgrid`	创建由 attr:tensors 中的 1D 输入指定的坐标网格。
`narrow`	返回一个新的张量，它是 `input` 张量的缩小版本。
`nn.functional.unfold`	从批处理输入张量中提取滑动局部块。
`ravel`	返回一个连续的扁平化张量。
`select`	在给定索引处沿选定维度对 `input` 张量进行切片。
`split`	将张量分割成块。
`stack`	沿着新维度连接一系列张量。
`t`	预期 `input` 是 <= 2D 张量，并转置维度 0 和 1。
`transpose`	返回一个转置后的 `input` 张量。
`vsplit`	根据 `indices_or_sections` 垂直地将 `input`（一个具有两个或更多维度的张量）分割成多个张量。
`vstack`	将张量按顺序垂直（按行）堆叠。
`Tensor.expand`	返回 `self` 张量的新的视图，其中单例维度扩展到更大的尺寸。
`Tensor.expand_as`	将此张量扩展到与 `other` 相同的大小。
`Tensor.reshape`	返回一个与 `self` 具有相同数据和元素数量的张量，但具有指定的形状。
`Tensor.reshape_as`	将此张量返回为与 `other` 相同的形状。
`Tensor.unfold`	返回原始张量的视图，其中包含 `self` 张量在维度 `dimension` 中大小为 `size` 的所有切片。
`Tensor.view`	返回一个与 `self` 张量具有相同数据但形状不同的新张量。