(原型) 掩码张量稀疏性

创建于：2022年10月28日 | 最后更新：2023年12月12日 | 最后验证：未验证

在开始本教程之前，请确保查看我们的MaskedTensor 概述教程 。

介绍

稀疏性一直是PyTorch中快速发展和重要的领域；如果下面的任何稀疏性术语令人困惑，请参考稀疏性教程以获取更多详细信息。

稀疏存储格式已被证明在多种方面非常强大。作为入门，大多数从业者首先想到的用例是当大多数元素等于零时（高度稀疏），但即使在稀疏度较低的情况下，某些格式（例如BSR）也可以利用矩阵中的子结构。

注意

目前，MaskedTensor支持COO和CSR张量，并计划在未来支持更多格式（如BSR和CSC）。如果您有任何关于其他格式的需求，请在此处提交功能请求here！

原则

当使用稀疏张量创建MaskedTensor时，必须遵循一些原则：

1. data 和 mask 必须具有相同的存储格式，无论是 torch.strided、torch.sparse_coo 还是 torch.sparse_csr

2. data 和 mask 必须具有相同的大小，由 size() 指示

稀疏COO张量

根据原则#1，通过传入两个稀疏COO张量来创建一个稀疏COO MaskedTensor，这些张量可以通过其任何构造函数进行初始化，例如torch.sparse_coo_tensor()。

作为对稀疏COO张量的回顾，COO格式代表“坐标格式”，其中指定的元素存储为其索引和相应值的元组。也就是说，提供了以下内容：

• indices: 大小为 (ndim, nse) 的数组，数据类型为 torch.int64

• values: 大小为 (nse,) 的数组，可以是任何整数或浮点数数据类型

其中 ndim 是张量的维度，nse 是指定元素的数量。

对于稀疏COO和CSR张量，您可以通过以下任一方式构建MaskedTensor：

1. masked_tensor(sparse_tensor_data, sparse_tensor_mask)

2. dense_masked_tensor.to_sparse_coo() 或 dense_masked_tensor.to_sparse_csr()

第二种方法更容易说明，因此我们在下面展示了它，但有关第一种方法及其背后的细微差别，请阅读Sparse COO 附录。

import torch
from torch.masked import masked_tensor
import warnings

# Disable prototype warnings and such
warnings.filterwarnings(action='ignore', category=UserWarning)

values = torch.tensor([[0, 0, 3], [4, 0, 5]])
mask = torch.tensor([[False, False, True], [False, False, True]])
mt = masked_tensor(values, mask)
sparse_coo_mt = mt.to_sparse_coo()

print("mt:\n", mt)
print("mt (sparse coo):\n", sparse_coo_mt)
print("mt data (sparse coo):\n", sparse_coo_mt.get_data())

mt:
 MaskedTensor(
  [
    [      --,       --, 3],
    [      --,       --, 5]
  ]
)
mt (sparse coo):
 MaskedTensor(
  [
    [      --,       --, 3],
    [      --,       --, 5]
  ]
)
mt data (sparse coo):
 tensor(indices=tensor([[0, 1],
                       [2, 2]]),
       values=tensor([3, 5]),
       size=(2, 3), nnz=2, layout=torch.sparse_coo)

稀疏CSR张量

同样地，MaskedTensor 也支持 CSR（压缩稀疏行） 稀疏张量格式。与稀疏COO张量存储索引元组不同，稀疏CSR张量 旨在通过存储压缩的行索引来减少内存需求。 具体来说，CSR稀疏张量由三个一维张量组成：

• crow_indices: 压缩行索引数组，大小为 (size[0] + 1,)。此数组指示值中给定条目所在的行。最后一个元素是指定元素的数量，而 crow_indices[i+1] - crow_indices[i] 表示第 i 行中指定元素的数量。

• col_indices: 大小为 (nnz,) 的数组。表示每个值的列索引。

• values: 大小为 (nnz,) 的数组。包含 CSR 张量的值。

值得注意的是，稀疏COO和CSR张量都处于beta状态。

例如：

mt_sparse_csr = mt.to_sparse_csr()

print("mt (sparse csr):\n", mt_sparse_csr)
print("mt data (sparse csr):\n", mt_sparse_csr.get_data())

mt (sparse csr):
 MaskedTensor(
  [
    [      --,       --, 3],
    [      --,       --, 5]
  ]
)
mt data (sparse csr):
 tensor(crow_indices=tensor([0, 1, 2]),
       col_indices=tensor([2, 2]),
       values=tensor([3, 5]), size=(2, 3), nnz=2, layout=torch.sparse_csr)

支持的操作

一元

所有一元运算符都支持，例如：

mt.sin()

MaskedTensor(
  [
    [      --,       --,   0.1411],
    [      --,       --,  -0.9589]
  ]
)

二进制

Binary operators 也被支持，但两个掩码张量的输入掩码必须匹配。有关为什么做出此决定的更多信息，请参阅我们的 MaskedTensor: Advanced Semantics tutorial。

请在下面找到一个示例：

i = [[0, 1, 1],
     [2, 0, 2]]
v1 = [3, 4, 5]
v2 = [20, 30, 40]
m = torch.tensor([True, False, True])

s1 = torch.sparse_coo_tensor(i, v1, (2, 3))
s2 = torch.sparse_coo_tensor(i, v2, (2, 3))
mask = torch.sparse_coo_tensor(i, m, (2, 3))

mt1 = masked_tensor(s1, mask)
mt2 = masked_tensor(s2, mask)

print("mt1:\n", mt1)
print("mt2:\n", mt2)

mt1:
 MaskedTensor(
  [
    [      --,       --, 3],
    [      --,       --, 5]
  ]
)
mt2:
 MaskedTensor(
  [
    [      --,       --, 20],
    [      --,       --, 40]
  ]
)

print("torch.div(mt2, mt1):\n", torch.div(mt2, mt1))
print("torch.mul(mt1, mt2):\n", torch.mul(mt1, mt2))

torch.div(mt2, mt1):
 MaskedTensor(
  [
    [      --,       --,   6.6667],
    [      --,       --,   8.0000]
  ]
)
torch.mul(mt1, mt2):
 MaskedTensor(
  [
    [      --,       --, 60],
    [      --,       --, 200]
  ]
)

归约

最后，支持reductions：

mt

MaskedTensor(
  [
    [      --,       --, 3],
    [      --,       --, 5]
  ]
)

print("mt.sum():\n", mt.sum())
print("mt.sum(dim=1):\n", mt.sum(dim=1))
print("mt.amin():\n", mt.amin())

mt.sum():
 MaskedTensor(8, True)
mt.sum(dim=1):
 MaskedTensor(
  [3, 5]
)
mt.amin():
 MaskedTensor(3, True)

MaskedTensor 辅助方法

为了方便起见，MaskedTensor 有许多方法可以帮助在不同布局之间进行转换并识别当前布局：

设置：

v = [[3, 0, 0],
     [0, 4, 5]]
m = [[True, False, False],
     [False, True, True]]

mt = masked_tensor(torch.tensor(v), torch.tensor(m))
mt

MaskedTensor(
  [
    [3,       --,       --],
    [      --, 4, 5]
  ]
)

MaskedTensor.to_sparse_coo() / MaskedTensor.to_sparse_csr() / MaskedTensor.to_dense() 用于帮助在不同布局之间进行转换。

mt_sparse_coo = mt.to_sparse_coo()
mt_sparse_csr = mt.to_sparse_csr()
mt_dense = mt_sparse_coo.to_dense()

MaskedTensor.is_sparse() – 这将检查MaskedTensor的布局是否匹配任何支持的稀疏布局（目前为COO和CSR）。

print("mt_dense.is_sparse: ", mt_dense.is_sparse)
print("mt_sparse_coo.is_sparse: ", mt_sparse_coo.is_sparse)
print("mt_sparse_csr.is_sparse: ", mt_sparse_csr.is_sparse)

mt_dense.is_sparse:  False
mt_sparse_coo.is_sparse:  True
mt_sparse_csr.is_sparse:  True

MaskedTensor.is_sparse_coo()

print("mt_dense.is_sparse_coo(): ", mt_dense.is_sparse_coo())
print("mt_sparse_coo.is_sparse_coo: ", mt_sparse_coo.is_sparse_coo())
print("mt_sparse_csr.is_sparse_coo: ", mt_sparse_csr.is_sparse_coo())

mt_dense.is_sparse_coo():  False
mt_sparse_coo.is_sparse_coo:  True
mt_sparse_csr.is_sparse_coo:  False

MaskedTensor.is_sparse_csr()

print("mt_dense.is_sparse_csr(): ", mt_dense.is_sparse_csr())
print("mt_sparse_coo.is_sparse_csr: ", mt_sparse_coo.is_sparse_csr())
print("mt_sparse_csr.is_sparse_csr: ", mt_sparse_csr.is_sparse_csr())

mt_dense.is_sparse_csr():  False
mt_sparse_coo.is_sparse_csr:  False
mt_sparse_csr.is_sparse_csr:  True

附录

稀疏COO构建

回想一下我们的原始示例，我们创建了一个MaskedTensor，然后使用MaskedTensor.to_sparse_coo()将其转换为稀疏COO MaskedTensor。

或者，我们也可以通过传入两个稀疏COO张量直接构造一个稀疏COO MaskedTensor：

values = torch.tensor([[0, 0, 3], [4, 0, 5]]).to_sparse()
mask = torch.tensor([[False, False, True], [False, False, True]]).to_sparse()
mt = masked_tensor(values, mask)

print("values:\n", values)
print("mask:\n", mask)
print("mt:\n", mt)

values:
 tensor(indices=tensor([[0, 1, 1],
                       [2, 0, 2]]),
       values=tensor([3, 4, 5]),
       size=(2, 3), nnz=3, layout=torch.sparse_coo)
mask:
 tensor(indices=tensor([[0, 1],
                       [2, 2]]),
       values=tensor([True, True]),
       size=(2, 3), nnz=2, layout=torch.sparse_coo)
mt:
 MaskedTensor(
  [
    [      --,       --, 3],
    [      --,       --, 5]
  ]
)

除了使用torch.Tensor.to_sparse()，我们还可以直接创建稀疏COO张量， 这给我们带来了一个警告：

警告

当使用像MaskedTensor.to_sparse_coo()（类似于Tensor.to_sparse()）这样的函数时， 如果用户没有像上面的例子中那样指定索引， 那么默认情况下，0值将被“未指定”。

下面，我们明确指定0：

i = [[0, 1, 1],
     [2, 0, 2]]
v = [3, 4, 5]
m = torch.tensor([True, False, True])
values = torch.sparse_coo_tensor(i, v, (2, 3))
mask = torch.sparse_coo_tensor(i, m, (2, 3))
mt2 = masked_tensor(values, mask)

print("values:\n", values)
print("mask:\n", mask)
print("mt2:\n", mt2)

values:
 tensor(indices=tensor([[0, 1, 1],
                       [2, 0, 2]]),
       values=tensor([3, 4, 5]),
       size=(2, 3), nnz=3, layout=torch.sparse_coo)
mask:
 tensor(indices=tensor([[0, 1, 1],
                       [2, 0, 2]]),
       values=tensor([ True, False,  True]),
       size=(2, 3), nnz=3, layout=torch.sparse_coo)
mt2:
 MaskedTensor(
  [
    [      --,       --, 3],
    [      --,       --, 5]
  ]
)

请注意，mt 和 mt2 在表面上看起来是相同的，并且在绝大多数操作中会产生相同的结果。但这让我们注意到一个实现细节：

data 和 mask – 仅适用于稀疏的 MaskedTensors – 在创建时可以有不同数量的元素 (nnz())，但 mask 的索引必须是 data 索引的子集。在这种情况下，data 将通过 data = data.sparse_mask(mask) 假设 mask 的形状；换句话说，data 中任何在 mask 中不为 True 的元素（即未指定的元素）将被丢弃。

因此，在底层，数据看起来略有不同；mt2 的“4”值被屏蔽了，而 mt 完全没有它。它们的基础数据具有不同的形状，这将使得像 mt + mt2 这样的操作无效。

print("mt data:\n", mt.get_data())
print("mt2 data:\n", mt2.get_data())

mt data:
 tensor(indices=tensor([[0, 1],
                       [2, 2]]),
       values=tensor([3, 5]),
       size=(2, 3), nnz=2, layout=torch.sparse_coo)
mt2 data:
 tensor(indices=tensor([[0, 1, 1],
                       [2, 0, 2]]),
       values=tensor([3, 4, 5]),
       size=(2, 3), nnz=3, layout=torch.sparse_coo)

稀疏CSR构建

我们也可以使用稀疏CSR张量来构建一个稀疏CSR MaskedTensor， 与上面的例子类似，这会在底层产生类似的处理。

crow_indices = torch.tensor([0, 2, 4])
col_indices = torch.tensor([0, 1, 0, 1])
values = torch.tensor([1, 2, 3, 4])
mask_values = torch.tensor([True, False, False, True])

csr = torch.sparse_csr_tensor(crow_indices, col_indices, values, dtype=torch.double)
mask = torch.sparse_csr_tensor(crow_indices, col_indices, mask_values, dtype=torch.bool)
mt = masked_tensor(csr, mask)

print("mt:\n", mt)
print("mt data:\n", mt.get_data())

mt:
 MaskedTensor(
  [
    [  1.0000,       --],
    [      --,   4.0000]
  ]
)
mt data:
 tensor(crow_indices=tensor([0, 2, 4]),
       col_indices=tensor([0, 1, 0, 1]),
       values=tensor([1., 2., 3., 4.]), size=(2, 2), nnz=4,
       dtype=torch.float64, layout=torch.sparse_csr)

结论

在本教程中，我们介绍了如何使用MaskedTensor与稀疏COO和CSR格式，并讨论了如果用户决定直接访问底层数据结构时的一些微妙之处。稀疏存储格式和掩码语义确实有很强的协同作用，以至于它们有时被用作彼此的代理（正如我们将在下一个教程中看到的那样）。未来，我们当然计划投资并继续朝这个方向发展。

进一步阅读

要继续学习更多内容，您可以查看我们的 使用MaskedTensor为Adagrad高效编写“稀疏”语义教程 ，以了解MaskedTensor如何通过原生掩码语义简化现有工作流程的示例。