torch.sparse¶
警告
稀疏张量的 PyTorch API 处于测试阶段，可能会在不久的将来发生变化。我们非常欢迎在 GitHub 上提出功能请求、错误报告和一般性建议。
稀疏性的用途和使用时机¶
默认情况下，PyTorch 将 torch.Tensor 元素连续地存储在物理内存中。这导致对各种数组处理算法的有效实现，这些算法需要快速访问元素。
现在，一些用户可能会决定通过张量表示数据，例如图邻接矩阵、修剪权重或点云，其元素大部分为零值。我们认识到这些是重要的应用程序，并旨在通过稀疏存储格式为这些用例提供性能优化。
多年来，已经开发了各种稀疏存储格式，例如 COO、CSR/CSC、半结构化、LIL 等。虽然它们在确切的布局上有所不同，但它们都通过有效表示零值元素来压缩数据。我们称未压缩的值为指定值，以区别于未指定的压缩元素。
通过压缩重复的零值，稀疏存储格式旨在节省各种 CPU 和 GPU 上的内存和计算资源。特别是对于高度稀疏性或高度结构化稀疏性，这可能会产生重大的性能影响。因此，稀疏存储格式可以被视为一种性能优化。
与许多其他性能优化一样，稀疏存储格式并不总是具有优势。当尝试对您的用例使用稀疏格式时，您可能会发现执行时间增加而不是减少。
如果您在分析中预期性能大幅提升，但实际测量到性能下降，请随时在 GitHub 上提交问题。这有助于我们优先实现高效内核和更广泛的性能优化。
我们让您能够轻松尝试不同的稀疏布局，并在它们之间进行转换，而无需对最适合您特定应用程序的内容发表意见。
功能概述¶
我们希望通过为每种布局提供转换例程，直接从给定的稠密张量构建稀疏张量。
在下一个示例中，我们将具有默认密集（跨步）布局的 2D 张量转换为由 COO 内存布局支持的 2D 张量。在这种情况下，仅存储非零元素的值和索引。
>>> a = torch.tensor([[0, 2.], [3, 0]])
>>> a.to_sparse()
tensor(indices=tensor([[0, 1],
[1, 0]]),
values=tensor([2., 3.]),
size=(2, 2), nnz=2, layout=torch.sparse_coo)
PyTorch 目前支持 COO、CSR、CSC、BSR 和 BSC。
我们还有一个原型实现来支持 :ref: 半结构化稀疏性<sparse-semi-structured-docs>。有关更多详细信息，请参阅参考。
请注意，我们提供了这些格式的一些轻微概括。
批处理：GPU 等设备需要批处理才能获得最佳性能，因此我们支持批处理维度。
我们目前提供批处理的一个非常简单的版本，其中稀疏格式的每个组件本身都是批处理的。这也要求每个批处理条目具有相同数量的指定元素。在此示例中，我们从 3D 密集张量构建 3D（批处理）CSR 张量。
>>> t = torch.tensor([[[1., 0], [2., 3.]], [[4., 0], [5., 6.]]])
>>> t.dim()
3
>>> t.to_sparse_csr()
tensor(crow_indices=tensor([[0, 1, 3],
[0, 1, 3]]),
col_indices=tensor([[0, 0, 1],
[0, 0, 1]]),
values=tensor([[1., 2., 3.],
[4., 5., 6.]]), size=(2, 2, 2), nnz=3,
layout=torch.sparse_csr)
密集维度：另一方面，某些数据（如图嵌入）可能更好地视为向量的稀疏集合，而不是标量。
在此示例中，我们从 3D 跨步张量创建具有 2 个稀疏维度和 1 个密集维度的 3D 混合 COO 张量。如果 3D 跨步张量中的整行都是零，则不存储该行。但是，如果行中的任何值都非零，则会全部存储它们。这减少了索引的数量，因为我们只需要每行一个索引，而不是每个元素一个索引。但它也增加了值的存储量。因为只有完全为零的行才能被发出，并且任何非零值元素的存在都会导致存储整行。
>>> t = torch.tensor([[[0., 0], [1., 2.]], [[0., 0], [3., 4.]]])
>>> t.to_sparse(sparse_dim=2)
tensor(indices=tensor([[0, 1],
[1, 1]]),
values=tensor([[1., 2.],
[3., 4.]]),
size=(2, 2, 2), nnz=2, layout=torch.sparse_coo)
运算符概述¶
从根本上讲，对具有稀疏存储格式的张量执行的操作与对具有跨步（或其他）存储格式的张量执行的操作的行为相同。存储的特殊性，即数据的物理布局，会影响操作的性能，但不应影响语义。
我们正在积极增加稀疏张量的运算符覆盖范围。用户不应期望对密集张量提供相同级别的支持。请参阅我们的 运算符 文档以获取列表。
>>> b = torch.tensor([[0, 0, 1, 2, 3, 0], [4, 5, 0, 6, 0, 0]])
>>> b_s = b.to_sparse_csr()
>>> b_s.cos()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
RuntimeError: unsupported tensor layout: SparseCsr
>>> b_s.sin()
tensor(crow_indices=tensor([0, 3, 6]),
col_indices=tensor([2, 3, 4, 0, 1, 3]),
values=tensor([ 0.8415, 0.9093, 0.1411, -0.7568, -0.9589, -0.2794]),
size=(2, 6), nnz=6, layout=torch.sparse_csr)
如上例所示，我们不支持非零保留一元运算符，例如 cos。非零保留一元运算符的输出将无法像输入那样充分利用稀疏存储格式，并可能导致内存急剧增加。相反，我们依赖于用户首先显式转换为密集张量，然后运行操作。
>>> b_s.to_dense().cos()
tensor([[ 1.0000, -0.4161],
[-0.9900, 1.0000]])
我们知道，一些用户希望忽略压缩零以进行诸如 cos 之类的操作，而不是保留操作的确切语义。为此，我们可以指向 torch.masked 及其 MaskedTensor，它反过来也由稀疏存储格式和内核支持和驱动。
另请注意，目前用户无法选择输出布局。例如，将稀疏张量添加到常规步幅张量中将生成步幅张量。一些用户可能更希望保留稀疏布局，因为他们知道结果仍然足够稀疏。
>>> a + b.to_sparse()
tensor([[0., 3.],
[3., 0.]])
我们承认，访问能够有效生成不同输出布局的内核非常有用。后续操作可能会因接收特定布局而受益匪浅。我们正在开发一个 API 来控制结果布局，并认识到这是一个重要的特性，可以为任何给定模型规划更优化的执行路径。
稀疏半结构化张量¶
警告
稀疏半结构化张量目前是一个原型特性，可能会发生变化。请随时提出问题来报告错误或分享您的反馈。
半结构化稀疏性是一种稀疏数据布局，最初在 NVIDIA 的 Ampere 架构中引入。它也被称为细粒度结构化稀疏性或2:4 结构化稀疏性。
此稀疏布局存储每 2n 个元素中的 n 个元素，其中 n 由张量数据类型 (dtype) 的宽度决定。使用最频繁的 dtype 是 float16，其中 n=2，因此称为“2:4 结构化稀疏性”。
半结构化稀疏性在此 NVIDIA 博客文章中进行了更详细的解释。
在 PyTorch 中，半结构化稀疏性通过张量子类实现。通过子类化，我们可以覆盖 __torch_dispatch__，从而允许我们在执行矩阵乘法时使用更快的稀疏内核。我们还可以在子类中以压缩形式存储张量，以减少内存开销。
在此压缩形式中，稀疏张量通过仅保留指定的元素和一些元数据来存储，这些元数据对掩码进行编码。
注意
半结构化稀疏张量的指定元素和元数据掩码一起存储在单个扁平压缩张量中。它们相互附加以形成连续的内存块。
压缩张量 = [原始张量的指定元素 | 元数据掩码]
对于大小为 (r, c) 的原始张量，我们期望前 m * k // 2 个元素是保留的元素，其余的张量是元数据。
为了使用户更容易查看指定的元素和掩码，可以使用 .indices() 和 .values() 分别访问掩码和指定的元素。
.values()返回大小为 (r, c//2) 且具有与稠密矩阵相同 dtype 的张量中的指定元素。.indices()返回大小为 (r, c//2 ) 的张量中的 metadata_mask，如果 dtype 为 torch.float16 或 torch.bfloat16，则元素类型为torch.int16，如果 dtype 为 torch.int8，则元素类型为torch.int32。
对于 2:4 稀疏张量，元数据开销很小 - 每个指定元素仅 2 位。
注意
需要注意的是，torch.float32 仅支持 1:2 稀疏性。因此，它不遵循上述公式。
在此，我们分解了如何计算 2:4 稀疏张量的压缩比（大小密集 / 大小稀疏）。
令 (r, c) = tensor.shape 和 e = bitwidth(tensor.dtype)，因此对于 torch.float16 和 torch.bfloat16，e = 16，对于 torch.int8，e = 8。
使用这些计算，我们可以确定原始密集表示和新的稀疏表示的总内存占用空间。
这为我们提供了一个压缩比的简单公式，该公式仅取决于张量数据类型的位宽。
通过使用此公式，我们发现对于 torch.float16 或 torch.bfloat16，压缩比为 56.25%，对于 torch.int8，压缩比为 62.5%。
构建稀疏半结构化张量¶
你可以通过简单地使用 torch.to_sparse_semi_structured 函数将密集张量转换为稀疏半结构化张量。
另请注意，我们只支持 CUDA 张量，因为半结构化稀疏性的硬件兼容性仅限于 NVIDIA GPU。
半结构化稀疏性支持以下数据类型。请注意，每种数据类型都有自己的形状约束和压缩因子。
PyTorch 数据类型 |
形状约束 |
压缩因子 |
稀疏模式 |
|---|---|---|---|
|
张量必须为 2D，并且 (r, c) 都必须是 64 的正倍数 |
9/16 |
2:4 |
|
张量必须为 2D，并且 (r, c) 都必须是 64 的正倍数 |
9/16 |
2:4 |
|
张量必须为 2D，并且 (r, c) 都必须是 128 的正倍数 |
10/16 |
2:4 |
要构建半结构化稀疏张量，首先创建一个遵循 2:4（或半结构化）稀疏格式的常规密集张量。为此，我们将一个小 1x4 条带平铺以创建一个 16x16 密集 float16 张量。之后，我们可以调用 to_sparse_semi_structured 函数对其进行压缩以进行加速推理。
>>> from torch.sparse import to_sparse_semi_structured
>>> A = torch.Tensor([0, 0, 1, 1]).tile((128, 32)).half().cuda()
tensor([[0., 0., 1., ..., 0., 1., 1.],
[0., 0., 1., ..., 0., 1., 1.],
[0., 0., 1., ..., 0., 1., 1.],
...,
[0., 0., 1., ..., 0., 1., 1.],
[0., 0., 1., ..., 0., 1., 1.],
[0., 0., 1., ..., 0., 1., 1.]], device='cuda:0', dtype=torch.float16)
>>> A_sparse = to_sparse_semi_structured(A)
SparseSemiStructuredTensor(shape=torch.Size([128, 128]), transposed=False, values=tensor([[1., 1., 1., ..., 1., 1., 1.],
[1., 1., 1., ..., 1., 1., 1.],
[1., 1., 1., ..., 1., 1., 1.],
...,
[1., 1., 1., ..., 1., 1., 1.],
[1., 1., 1., ..., 1., 1., 1.],
[1., 1., 1., ..., 1., 1., 1.]], device='cuda:0', dtype=torch.float16), metadata=tensor([[-4370, -4370, -4370, ..., -4370, -4370, -4370],
[-4370, -4370, -4370, ..., -4370, -4370, -4370],
[-4370, -4370, -4370, ..., -4370, -4370, -4370],
...,
[-4370, -4370, -4370, ..., -4370, -4370, -4370],
[-4370, -4370, -4370, ..., -4370, -4370, -4370],
[-4370, -4370, -4370, ..., -4370, -4370, -4370]], device='cuda:0',
dtype=torch.int16))
稀疏半结构化张量操作¶
目前，半结构化稀疏张量支持以下操作
torch.addmm(bias, dense, sparse.t())
torch.mm(稠密，稀疏)
torch.mm(稀疏，稠密)
aten.linear.default(稠密，稀疏，偏差)
aten.t.default(稀疏)
aten.t.detach(稀疏)
若要使用这些操作，只需在张量采用半结构稀疏格式（其中 0 以半结构方式存在）时，将 to_sparse_semi_structured(tensor) 的输出传递，而不是使用 tensor，如下所示
>>> a = torch.Tensor([0, 0, 1, 1]).tile((64, 16)).half().cuda()
>>> b = torch.rand(64, 64).half().cuda()
>>> c = torch.mm(a, b)
>>> a_sparse = to_sparse_semi_structured(a)
>>> torch.allclose(c, torch.mm(a_sparse, b))
True
使用半结构稀疏性加速 nn.Linear¶
如果权重已经是半结构稀疏的，只需几行代码，即可加速模型中的线性层
>>> input = torch.rand(64, 64).half().cuda()
>>> mask = torch.Tensor([0, 0, 1, 1]).tile((64, 16)).cuda().bool()
>>> linear = nn.Linear(64, 64).half().cuda()
>>> linear.weight = nn.Parameter(to_sparse_semi_structured(linear.weight.masked_fill(~mask, 0)))
稀疏 COO 张量¶
PyTorch 将所谓的坐标格式或 COO 格式作为实现稀疏张量的一种存储格式。在 COO 格式中，指定元素存储为元素索引和相应值的元组。具体而言，
指定元素的索引收集在大小为
(ndim, nse)且元素类型为torch.int64的indices张量中，相应的值收集在大小为
(nse,)且具有任意整数或浮点数元素类型的values张量中，
其中 ndim 是张量的维度，nse 是指定元素的数量。
注意
稀疏 COO 张量的内存消耗至少为 (ndim * 8 + <以 字节为单位的 元素 类型 大小>) * nse 字节（加上存储其他张量数据的固定开销）。
带步长的张量的内存消耗至少为 product(<tensor shape>) * <size of element type in bytes>。
例如，一个 10 000 x 10 000 张量，其中有 100 000 个非零 32 位浮点数，其内存消耗至少为 (2 * 8 + 4) * 100 000 = 2 000 000 字节（使用 COO 张量布局时）和 10 000 * 10 000 * 4 = 400 000 000 字节（使用默认带步长的张量布局时）。请注意，使用 COO 存储格式可节省 200 倍的内存。
构造¶
可以通过向函数 torch.sparse_coo_tensor() 提供两个索引和值张量，以及稀疏张量的大小（如果无法从索引和值张量中推断出该大小），来构造稀疏 COO 张量。
假设我们要定义一个稀疏张量，其中 (0, 2) 处的值为 3，(1, 0) 处的值为 4，(1, 2) 处的值为 5。未指定的元素假定具有相同的值，即填充值，默认值为零。然后，我们可以写出
>>> i = [[0, 1, 1],
[2, 0, 2]]
>>> v = [3, 4, 5]
>>> s = torch.sparse_coo_tensor(i, v, (2, 3))
>>> s
tensor(indices=tensor([[0, 1, 1],
[2, 0, 2]]),
values=tensor([3, 4, 5]),
size=(2, 3), nnz=3, layout=torch.sparse_coo)
>>> s.to_dense()
tensor([[0, 0, 3],
[4, 0, 5]])
请注意，输入 i 不是索引元组列表。如果您想以这种方式编写索引，则应在将它们传递给稀疏构造函数之前进行转置
>>> i = [[0, 2], [1, 0], [1, 2]]
>>> v = [3, 4, 5 ]
>>> s = torch.sparse_coo_tensor(list(zip(*i)), v, (2, 3))
>>> # Or another equivalent formulation to get s
>>> s = torch.sparse_coo_tensor(torch.tensor(i).t(), v, (2, 3))
>>> torch.sparse_coo_tensor(i.t(), v, torch.Size([2,3])).to_dense()
tensor([[0, 0, 3],
[4, 0, 5]])
可以通过仅指定其大小来构造一个空的稀疏 COO 张量
>>> torch.sparse_coo_tensor(size=(2, 3))
tensor(indices=tensor([], size=(2, 0)),
values=tensor([], size=(0,)),
size=(2, 3), nnz=0, layout=torch.sparse_coo)
稀疏混合 COO 张量¶
PyTorch 实现了稀疏张量扩展，将标量值稀疏张量扩展为（连续）张量值的稀疏张量。此类张量称为混合张量。
PyTorch 混合 COO 张量通过允许 values 张量成为多维张量来扩展稀疏 COO 张量，以便我们拥有
指定元素的索引收集在大小为
(sparse_dims, nse)且元素类型为torch.int64的indices张量中，相应的（张量）值收集在大小为
(nse, dense_dims)且具有任意整数或浮点数元素类型的values张量中。
注意
我们使用 (M + K) 维张量表示 N 维稀疏混合张量，其中 M 和 K 分别是稀疏维度和稠密维度的数量，使得 M + K == N 成立。
假设我们要创建一个 (2 + 1) 维张量，其中在位置 (0, 2) 处有条目 [3, 4]，在位置 (1, 0) 处有条目 [5, 6]，在位置 (1, 2) 处有条目 [7, 8]。我们可以写出
>>> i = [[0, 1, 1],
[2, 0, 2]]
>>> v = [[3, 4], [5, 6], [7, 8]]
>>> s = torch.sparse_coo_tensor(i, v, (2, 3, 2))
>>> s
tensor(indices=tensor([[0, 1, 1],
[2, 0, 2]]),
values=tensor([[3, 4],
[5, 6],
[7, 8]]),
size=(2, 3, 2), nnz=3, layout=torch.sparse_coo)
>>> s.to_dense()
tensor([[[0, 0],
[0, 0],
[3, 4]],
[[5, 6],
[0, 0],
[7, 8]]])
一般来说，如果 s 是稀疏 COO 张量，且 M = s.sparse_dim()，K = s.dense_dim()，那么我们有以下不变量
M + K == len(s.shape) == s.ndim- 张量的维数是稀疏维度和稠密维度的数量之和，
s.indices().shape == (M, nse)- 稀疏索引显式存储，
s.values().shape == (nse,) + s.shape[M : M + K]- 混合张量的值是 K 维张量，
s.values().layout == torch.strided- 值存储为跨步张量。
注意
密集维度始终紧随稀疏维度，即不支持混合密集维度和稀疏维度。
注意
为确保构造的稀疏张量具有始终如一的索引、值和大小，可以通过 check_invariants=True 关键字参数在创建每个张量时启用不变性检查，或使用 torch.sparse.check_sparse_tensor_invariants 上下文管理器实例全局启用。默认情况下，稀疏张量不变性检查处于禁用状态。
未合并稀疏 COO 张量¶
PyTorch 稀疏 COO 张量格式允许稀疏未合并张量，其中索引中可能存在重复坐标；在这种情况下，解释为该索引处的值为所有重复值条目的总和。例如，可以为同一索引 1 指定多个值 3 和 4，这将导致 1-D 未合并张量
>>> i = [[1, 1]]
>>> v = [3, 4]
>>> s=torch.sparse_coo_tensor(i, v, (3,))
>>> s
tensor(indices=tensor([[1, 1]]),
values=tensor( [3, 4]),
size=(3,), nnz=2, layout=torch.sparse_coo)
而合并过程将使用求和将多值元素累积为单个值
>>> s.coalesce()
tensor(indices=tensor([[1]]),
values=tensor([7]),
size=(3,), nnz=1, layout=torch.sparse_coo)
通常，torch.Tensor.coalesce() 方法的输出是具有以下属性的稀疏张量
指定张量元素的索引是唯一的，
索引按字典顺序排序，
torch.Tensor.is_coalesced()返回True。
注意
在大多数情况下，您不必关心稀疏张量是否已合并，因为大多数操作在给定稀疏合并或未合并张量时都会以相同的方式工作。
但是，某些操作可以在未合并张量上更有效地实现，而另一些操作可以在合并张量上更有效地实现。
例如，稀疏 COO 张量的加法通过简单地连接索引和值张量来实现
>>> a = torch.sparse_coo_tensor([[1, 1]], [5, 6], (2,))
>>> b = torch.sparse_coo_tensor([[0, 0]], [7, 8], (2,))
>>> a + b
tensor(indices=tensor([[0, 0, 1, 1]]),
values=tensor([7, 8, 5, 6]),
size=(2,), nnz=4, layout=torch.sparse_coo)
如果您重复执行可能产生重复条目的操作（例如，torch.Tensor.add()），则应偶尔合并稀疏张量以防止它们增长过大。
另一方面，索引的字典顺序对于实现涉及许多元素选择操作的算法（例如切片或矩阵乘积）是有利的。
使用稀疏 COO 张量¶
考虑以下示例
>>> i = [[0, 1, 1],
[2, 0, 2]]
>>> v = [[3, 4], [5, 6], [7, 8]]
>>> s = torch.sparse_coo_tensor(i, v, (2, 3, 2))
如上所述，稀疏 COO 张量是一个 torch.Tensor 实例，为了将其与使用其他布局的 Tensor 实例区分开来，可以使用 torch.Tensor.is_sparse 或 torch.Tensor.layout 属性
>>> isinstance(s, torch.Tensor)
True
>>> s.is_sparse
True
>>> s.layout == torch.sparse_coo
True
可以使用 torch.Tensor.sparse_dim() 和 torch.Tensor.dense_dim() 方法分别获取稀疏维度和稠密维度的数量。例如
>>> s.sparse_dim(), s.dense_dim()
(2, 1)
如果 s 是一个稀疏 COO 张量，则可以使用 torch.Tensor.indices() 和 torch.Tensor.values() 方法获取其 COO 格式数据。
注意
目前，只有在张量实例合并后才能获取 COO 格式数据
>>> s.indices()
RuntimeError: Cannot get indices on an uncoalesced tensor, please call .coalesce() first
要获取未合并张量的 COO 格式数据，请使用 torch.Tensor._values() 和 torch.Tensor._indices()
>>> s._indices()
tensor([[0, 1, 1],
[2, 0, 2]])
警告
调用 torch.Tensor._values() 将返回一个分离的张量。要跟踪梯度，必须使用 torch.Tensor.coalesce().values()。
构造一个新的稀疏 COO 张量将产生一个未合并的张量
>>> s.is_coalesced()
False
但是可以使用 torch.Tensor.coalesce() 方法构造一个合并的稀疏 COO 张量副本
>>> s2 = s.coalesce()
>>> s2.indices()
tensor([[0, 1, 1],
[2, 0, 2]])
在使用未合并的稀疏 COO 张量时，必须考虑未合并数据的加法性质：相同索引的值是求和的项，求值会给出相应张量元素的值。例如，稀疏未合并张量上的标量乘法可以通过将所有未合并的值与标量相乘来实现，因为 c * (a + b) == c * a + c * b 成立。但是，任何非线性操作（例如平方根）都不能通过将操作应用于未合并的数据来实现，因为 sqrt(a + b) == sqrt(a) + sqrt(b) 通常不成立。
稀疏 COO 张量的切片（步长为正）仅支持稠密维度。稀疏和稠密维度都支持索引。
>>> s[1]
tensor(indices=tensor([[0, 2]]),
values=tensor([[5, 6],
[7, 8]]),
size=(3, 2), nnz=2, layout=torch.sparse_coo)
>>> s[1, 0, 1]
tensor(6)
>>> s[1, 0, 1:]
tensor([6])
在 PyTorch 中，不能显式指定稀疏张量的填充值，通常假定为零。但是，存在可能以不同方式解释填充值的运算。例如，torch.sparse.softmax() 计算 softmax，假设填充值为负无穷大。
稀疏压缩张量¶
稀疏压缩张量表示一类稀疏张量，这些张量具有使用编码压缩特定维度索引的共同特征，该编码能够对稀疏压缩张量的线性代数核进行某些优化。此编码基于压缩稀疏行 (CSR)格式，PyTorch 稀疏压缩张量通过支持稀疏张量批次、允许多维张量值以及将稀疏张量值存储在稠密块中来扩展该格式。
注意
我们使用 (B + M + K) 维张量来表示 N 维稀疏压缩混合张量，其中 B、M 和 K 分别是批次、稀疏和稠密维度的数量，使得 B + M + K == N 成立。稀疏压缩张量的稀疏维度数量始终为两个，M == 2。
注意
如果满足以下不变量，我们称索引张量 compressed_indices 使用 CSR 编码
compressed_indices是一个连续步长的 32 或 64 位整数张量compressed_indices形状为(*batchsize, compressed_dim_size + 1)，其中compressed_dim_size是压缩维度（例如行或列）的数量compressed_indices[..., 0] == 0，其中...表示批次索引compressed_indices[..., compressed_dim_size] == nse，其中nse是指定元素的数量0 <= compressed_indices[..., i] - compressed_indices[..., i - 1] <= plain_dim_size，对于i=1, ..., compressed_dim_size，其中plain_dim_size是普通维度（垂直于压缩维度，例如列或行）的数量。
为确保构造的稀疏张量具有始终如一的索引、值和大小，可以通过 check_invariants=True 关键字参数在创建每个张量时启用不变性检查，或使用 torch.sparse.check_sparse_tensor_invariants 上下文管理器实例全局启用。默认情况下，稀疏张量不变性检查处于禁用状态。
注意
稀疏压缩布局对 N 维张量的泛化可能会导致对指定元素计数产生一些困惑。当稀疏压缩张量包含批次维度时，指定元素的数量将对应于每个批次的此类元素的数量。当稀疏压缩张量具有稠密维度时，所考虑的元素现在是 K 维数组。此外，对于块稀疏压缩布局，2D 块被视为正在指定的元素。以一个 3 维块稀疏张量为例，它具有长度为 b 的一个批次维度，以及 p, q 的块形状。如果此张量具有 n 个指定元素，那么实际上我们有每个批次指定 n 个块。此张量将具有形状为 (b, n, p, q) 的 values。对指定元素数量的这种解释源自所有稀疏压缩布局都源自 2 维矩阵的压缩。批次维度被视为稀疏矩阵的堆叠，稠密维度将元素的含义从简单的标量值更改为具有自身维度的数组。
稀疏 CSR 张量¶
CSR 格式相较于 COO 格式的主要优势在于它能更好地利用存储，并能显著加快计算操作的速度，例如使用 MKL 和 MAGMA 后端的稀疏矩阵-向量乘法。
在最简单的情况下，一个 (0 + 2 + 0) 维稀疏 CSR 张量由三个 1-D 张量组成：crow_indices、col_indices 和 values
crow_indices张量由压缩的行索引组成。这是一个大小为nrows + 1（行数加 1）的 1-D 张量。crow_indices的最后一个元素是指定元素的数量，nse。此张量对values和col_indices中的索引进行编码，具体取决于给定行从何处开始。张量中每个连续的数字减去它之前的数字表示给定行中的元素数量。
col_indices张量包含每个元素的列索引。这是一个大小为nse的 1-D 张量。
values张量包含 CSR 张量元素的值。这是一个大小为nse的 1-D 张量。
注意
索引张量 crow_indices 和 col_indices 的元素类型应为 torch.int64（默认）或 torch.int32。如果您想使用支持 MKL 的矩阵操作，请使用 torch.int32。这是因为 pytorch 的默认链接方式是使用 MKL LP64，它使用 32 位整数索引。
在一般情况下，(B + 2 + K) 维稀疏 CSR 张量由两个 (B + 1) 维索引张量 crow_indices 和 col_indices 以及 (1 + K) 维 values 张量组成，使得
crow_indices.shape == (*batchsize, nrows + 1)
col_indices.shape == (*batchsize, nse)
values.shape == (nse, *densesize)
而稀疏 CSR 张量的形状为 (*batchsize, nrows, ncols, *densesize) 其中 len(batchsize) == B 且 len(densesize) == K。
注意
稀疏 CSR 张量批次是相关的：所有批次中指定元素的数量必须相同。这种有点人为的约束允许有效存储不同 CSR 批次的索引。
注意
可以使用 torch.Tensor.sparse_dim() 和 torch.Tensor.dense_dim() 方法获取稀疏维度和稠密维度的数量。批次维度可以从张量形状中计算得出：batchsize = tensor.shape[:-tensor.sparse_dim() - tensor.dense_dim()]。
注意
稀疏 CSR 张量的内存消耗至少为 (nrows * 8 + (8 + <size of element type in bytes> * prod(densesize)) * nse) * prod(batchsize) 字节（加上存储其他张量数据的固定开销）。
使用 稀疏 COO 格式简介中的注释 中的相同示例数据，一个 10 000 x 10 000 张量（包含 100 000 个非零 32 位浮点数）在使用 CSR 张量布局时的内存消耗至少为 (10000 * 8 + (8 + 4 * 1) * 100 000) * 1 = 1 280 000 字节。请注意，与分别使用 COO 和步幅格式相比，使用 CSR 存储格式节省了 1.6 倍和 310 倍的内存。
CSR 张量的构造¶
可以使用 torch.sparse_csr_tensor() 函数直接构造稀疏 CSR 张量。用户必须分别提供行索引、列索引和值张量，其中行索引必须使用 CSR 压缩编码指定。如果 size 参数不存在，则将从 crow_indices 和 col_indices 推断出该参数。
>>> crow_indices = torch.tensor([0, 2, 4])
>>> col_indices = torch.tensor([0, 1, 0, 1])
>>> values = torch.tensor([1, 2, 3, 4])
>>> csr = torch.sparse_csr_tensor(crow_indices, col_indices, values, dtype=torch.float64)
>>> csr
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)
>>> csr.to_dense()
tensor([[1., 2.],
[3., 4.]], dtype=torch.float64)
注意
推断的 size 中稀疏维度值从 crow_indices 的大小和 col_indices 中的最大索引值计算得出。如果列数需要大于推断的 size，则必须明确指定 size 参数。
从步长或稀疏 COO 张量构建 2-D 稀疏 CSR 张量的最简单方法是使用 torch.Tensor.to_sparse_csr() 方法。稀疏张量中 (步长) 张量中的任何零都将被解释为缺失值
>>> a = torch.tensor([[0, 0, 1, 0], [1, 2, 0, 0], [0, 0, 0, 0]], dtype=torch.float64)
>>> sp = a.to_sparse_csr()
>>> sp
tensor(crow_indices=tensor([0, 1, 3, 3]),
col_indices=tensor([2, 0, 1]),
values=tensor([1., 1., 2.]), size=(3, 4), nnz=3, dtype=torch.float64)
CSR 张量操作¶
稀疏矩阵-向量乘法可以使用 tensor.matmul() 方法执行。这目前是 CSR 张量支持的唯一数学运算。
>>> vec = torch.randn(4, 1, dtype=torch.float64)
>>> sp.matmul(vec)
tensor([[0.9078],
[1.3180],
[0.0000]], dtype=torch.float64)
稀疏 CSC 张量¶
稀疏 CSC（压缩稀疏列）张量格式为 2 维张量存储实现 CSC 格式，并扩展为支持稀疏 CSC 张量批处理和多维张量值。
注意
稀疏 CSC 张量本质上是稀疏 CSR 张量的转置，当转置关于交换稀疏维度时。
与 稀疏 CSR 张量 类似，稀疏 CSC 张量由三个张量组成：ccol_indices、row_indices 和 values
张量由压缩的列索引组成。这是一个形状为ccol_indices的 (B + 1)-D 张量。最后一个元素是指定元素的数量，(*batchsize, ncols + 1)。此张量对nse和values中的索引进行编码，具体取决于给定列的起始位置。张量中每个连续数字减去它之前的数字表示给定列中的元素数量。row_indices
张量包含每个元素的行索引。这是一个形状为row_indices的 (B + 1)-D 张量。(*batchsize, nse)
张量包含 CSC 张量元素的值。这是一个形状为values的 (1 + K)-D 张量。(nse, *densesize)
CSC 张量的构建¶
可以使用 torch.sparse_csc_tensor() 函数直接构建稀疏 CSC 张量。用户必须分别提供行和列索引以及值张量，其中列索引必须使用 CSR 压缩编码指定。如果不存在 sizerow_indicesccol_indices
>>> ccol_indices = torch.tensor([0, 2, 4])
>>> row_indices = torch.tensor([0, 1, 0, 1])
>>> values = torch.tensor([1, 2, 3, 4])
>>> csc = torch.sparse_csc_tensor(ccol_indices, row_indices, values, dtype=torch.float64)
>>> csc
tensor(ccol_indices=tensor([0, 2, 4]),
row_indices=tensor([0, 1, 0, 1]),
values=tensor([1., 2., 3., 4.]), size=(2, 2), nnz=4,
dtype=torch.float64, layout=torch.sparse_csc)
>>> csc.to_dense()
tensor([[1., 3.],
[2., 4.]], dtype=torch.float64)
注意
稀疏 CSC 张量构造函数在行索引参数之前具有压缩列索引参数。
可以使用 torch.Tensor.to_sparse_csc() 方法从任何二维张量构建 (0 + 2 + 0) 维稀疏 CSC 张量。在稀疏张量中，(跨步) 张量中的任何零都将被解释为缺失值
>>> a = torch.tensor([[0, 0, 1, 0], [1, 2, 0, 0], [0, 0, 0, 0]], dtype=torch.float64)
>>> sp = a.to_sparse_csc()
>>> sp
tensor(ccol_indices=tensor([0, 1, 2, 3, 3]),
row_indices=tensor([1, 1, 0]),
values=tensor([1., 2., 1.]), size=(3, 4), nnz=3, dtype=torch.float64,
layout=torch.sparse_csc)
稀疏 BSR 张量¶
稀疏 BSR（块压缩稀疏行）张量格式实现了 BSR 格式，用于存储具有扩展功能的二维张量，以支持稀疏 BSR 张量的批处理，并将值作为多维张量的块。
稀疏 BSR 张量由三个张量组成：crow_indices、col_indices 和 values
crow_indices张量由压缩行索引组成。这是一个形状为(*batchsize, nrowblocks + 1)的 (B + 1)-D 张量。最后一个元素是指定块的数量nse。此张量对values和col_indices中的索引进行编码，具体取决于给定列块的起始位置。张量中每个连续数字减去它之前的数字表示给定行中的块数。
col_indices张量包含每个元素的列块索引。这是一个形状为(*batchsize, nse)的 (B + 1)-D 张量。
values张量包含稀疏 BSR 张量元素的值，这些值被收集到二维块中。这是一个形状为(nse, nrowblocks, ncolblocks, *densesize)的 (1 + 2 + K)-D 张量。
BSR 张量的构造¶
稀疏 BSR 张量可以直接使用 torch.sparse_bsr_tensor() 函数进行构建。用户必须分别提供行和列块索引和值张量，其中行块索引必须使用 CSR 压缩编码进行指定。如果 size 参数不存在，则它是可选的，并且将从 crow_indices 和 col_indices 张量中推断出来。
>>> crow_indices = torch.tensor([0, 2, 4])
>>> col_indices = torch.tensor([0, 1, 0, 1])
>>> values = torch.tensor([[[0, 1, 2], [6, 7, 8]],
... [[3, 4, 5], [9, 10, 11]],
... [[12, 13, 14], [18, 19, 20]],
... [[15, 16, 17], [21, 22, 23]]])
>>> bsr = torch.sparse_bsr_tensor(crow_indices, col_indices, values, dtype=torch.float64)
>>> bsr
tensor(crow_indices=tensor([0, 2, 4]),
col_indices=tensor([0, 1, 0, 1]),
values=tensor([[[ 0., 1., 2.],
[ 6., 7., 8.]],
[[ 3., 4., 5.],
[ 9., 10., 11.]],
[[12., 13., 14.],
[18., 19., 20.]],
[[15., 16., 17.],
[21., 22., 23.]]]),
size=(4, 6), nnz=4, dtype=torch.float64, layout=torch.sparse_bsr)
>>> bsr.to_dense()
tensor([[ 0., 1., 2., 3., 4., 5.],
[ 6., 7., 8., 9., 10., 11.],
[12., 13., 14., 15., 16., 17.],
[18., 19., 20., 21., 22., 23.]], dtype=torch.float64)
可以使用 torch.Tensor.to_sparse_bsr() 方法从任何二维张量构建 (0 + 2 + 0) 维稀疏 BSR 张量，该方法还要求指定值块大小
>>> dense = torch.tensor([[0, 1, 2, 3, 4, 5],
... [6, 7, 8, 9, 10, 11],
... [12, 13, 14, 15, 16, 17],
... [18, 19, 20, 21, 22, 23]])
>>> bsr = dense.to_sparse_bsr(blocksize=(2, 3))
>>> bsr
tensor(crow_indices=tensor([0, 2, 4]),
col_indices=tensor([0, 1, 0, 1]),
values=tensor([[[ 0, 1, 2],
[ 6, 7, 8]],
[[ 3, 4, 5],
[ 9, 10, 11]],
[[12, 13, 14],
[18, 19, 20]],
[[15, 16, 17],
[21, 22, 23]]]), size=(4, 6), nnz=4,
layout=torch.sparse_bsr)
稀疏 BSC 张量¶
稀疏 BSC（块压缩稀疏列）张量格式实现了 BSC 格式，用于存储二维张量，并扩展为支持稀疏 BSC 张量的批处理，而值是多维张量的块。
稀疏 BSC 张量由三个张量组成：ccol_indices、row_indices 和 values
ccol_indices张量由压缩列索引组成。这是一个形状为(*batchsize, ncolblocks + 1)的 (B + 1)-D 张量。最后一个元素是指定块的数量nse。此张量对values和row_indices中的索引进行编码，具体取决于给定的行块的起始位置。张量中每个连续数字减去它之前的数字表示给定列中的块数。
row_indices张量包含每个元素的行块索引。这是一个形状为(*batchsize, nse)的 (B + 1)-D 张量。
values张量包含稀疏 BSC 张量元素的值，这些值收集到二维块中。这是一个形状为(nse, nrowblocks, ncolblocks, *densesize)的 (1 + 2 + K)-D 张量。
BSC 张量的构建¶
稀疏 BSC 张量可以通过使用 torch.sparse_bsc_tensor() 函数直接构建。用户必须分别提供行和列块索引和值张量，其中列块索引必须使用 CSR 压缩编码指定。size 参数是可选的，如果不存在，将从 ccol_indices 和 row_indices 张量中推断出来。
>>> ccol_indices = torch.tensor([0, 2, 4])
>>> row_indices = torch.tensor([0, 1, 0, 1])
>>> values = torch.tensor([[[0, 1, 2], [6, 7, 8]],
... [[3, 4, 5], [9, 10, 11]],
... [[12, 13, 14], [18, 19, 20]],
... [[15, 16, 17], [21, 22, 23]]])
>>> bsc = torch.sparse_bsc_tensor(ccol_indices, row_indices, values, dtype=torch.float64)
>>> bsc
tensor(ccol_indices=tensor([0, 2, 4]),
row_indices=tensor([0, 1, 0, 1]),
values=tensor([[[ 0., 1., 2.],
[ 6., 7., 8.]],
[[ 3., 4., 5.],
[ 9., 10., 11.]],
[[12., 13., 14.],
[18., 19., 20.]],
[[15., 16., 17.],
[21., 22., 23.]]]), size=(4, 6), nnz=4,
dtype=torch.float64, layout=torch.sparse_bsc)
使用稀疏压缩张量的工具¶
所有稀疏压缩张量（CSR、CSC、BSR 和 BSC 张量）在概念上非常相似，因为它们的索引数据被分成两部分：使用 CSR 编码的所谓压缩索引，以及与压缩索引正交的所谓纯索引。这允许这些张量上的各种工具共享由张量布局参数化的相同实现。
稀疏压缩张量的构建¶
稀疏 CSR、CSC、BSR 和 CSC 张量可以通过使用 torch.sparse_compressed_tensor() 函数构建，该函数具有与上面讨论的构造函数 torch.sparse_csr_tensor()、torch.sparse_csc_tensor()、torch.sparse_bsr_tensor() 和 torch.sparse_bsc_tensor() 相同的接口，但需要额外的 layout 参数。以下示例说明了通过将相应的布局参数指定给 torch.sparse_compressed_tensor() 函数，使用相同输入数据构建 CSR 和 CSC 张量的方法
>>> compressed_indices = torch.tensor([0, 2, 4])
>>> plain_indices = torch.tensor([0, 1, 0, 1])
>>> values = torch.tensor([1, 2, 3, 4])
>>> csr = torch.sparse_compressed_tensor(compressed_indices, plain_indices, values, layout=torch.sparse_csr)
>>> csr
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,
layout=torch.sparse_csr)
>>> csc = torch.sparse_compressed_tensor(compressed_indices, plain_indices, values, layout=torch.sparse_csc)
>>> csc
tensor(ccol_indices=tensor([0, 2, 4]),
row_indices=tensor([0, 1, 0, 1]),
values=tensor([1, 2, 3, 4]), size=(2, 2), nnz=4,
layout=torch.sparse_csc)
>>> (csr.transpose(0, 1).to_dense() == csc.to_dense()).all()
tensor(True)
支持的操作¶
线性代数运算¶
下表总结了稀疏矩阵支持的线性代数运算，其中操作数的布局可能有所不同。此处 T[layout] 表示具有给定布局的张量。类似地，M[layout] 表示矩阵（2-D PyTorch 张量），V[layout] 表示向量（1-D PyTorch 张量）。此外，f 表示标量（浮点数或 0-D PyTorch 张量），* 是逐元素乘法，@ 是矩阵乘法。
PyTorch 运算 |
稀疏梯度？ |
布局签名 |
|---|---|---|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
是 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
否 |
|
|
是 |
|
|
否 |
|
|
否 |
|
|
是 |
|
|
是 |
|
其中，“稀疏梯度？”列指示 PyTorch 操作是否支持关于稀疏矩阵参数的反向传播。除了 torch.smm() 之外的所有 PyTorch 操作都支持关于步进矩阵参数的反向传播。
注意
目前，PyTorch 不支持布局签名为 M[strided] @ M[sparse_coo] 的矩阵乘法。但是，应用程序仍然可以使用矩阵关系 D @ S == (S.t() @ D.t()).t() 来计算它。
张量方法和稀疏¶
以下张量方法与稀疏张量相关
如果张量使用稀疏 COO 存储布局，则为 |
|
如果张量使用稀疏 CSR 存储布局，则为 |
|
返回 稀疏张量 |
|
返回 稀疏张量 |
|
返回一个新的 稀疏张量，其值来自按稀疏张量 |
|
返回张量的稀疏副本。 |
|
将张量转换为 坐标格式。 |
|
将张量转换为压缩行存储格式 (CSR)。 |
|
将张量转换为压缩列存储 (CSC) 格式。 |
|
将张量转换为给定块大小的块稀疏行 (BSR) 存储格式。 |
|
将张量转换为给定块大小的块稀疏列 (BSC) 存储格式。 |
|
如果 |
|
返回 稀疏 COO 张量 的值张量。 |
以下 Tensor 方法特定于稀疏 COO 张量
如果 |
|
将 稀疏张量 |
|
从 稀疏张量 |
|
如果 |
|
返回 稀疏 COO 张量 的索引张量。 |
当 |
|
当 |
以下 Tensor 方法支持稀疏 COO 张量
add()
add_()
addmm()
addmm_()
any()
asin()
asin_()
arcsin()
arcsin_()
bmm()
clone()
deg2rad()
deg2rad_()
detach()
detach_()
dim()
div()
div_()
floor_divide()
floor_divide_()
get_device()
index_select()
isnan()
log1p()
log1p_()
mm()
mul()
mul_()
mv()
narrow_copy()
neg()
neg_()
negative()
negative_()
numel()
rad2deg()
rad2deg_()
resize_as_()
size()
pow()
sqrt()
square()
smm()
sspaddmm()
sub()
sub_()
t()
t_()
transpose()
transpose_()
zero_()
特定于稀疏张量的 Torch 函数¶
使用给定的 |
|
使用给定的 |
|
使用给定的 |
|
使用给定的 |
|
使用给定的 |
|
使用给定的 |
|
返回给定稀疏张量的每一行的和。 |
|
此函数在正向传播中与 |
|
在 |
|
执行稀疏矩阵 |
|
将稀疏张量 |
|
执行稀疏 COO 矩阵 |
|
使用稠密矩阵 |
|
应用 softmax 函数。 |
|
应用 softmax 函数，然后取对数。 |
|
通过将 |
其他函数¶
以下 torch 函数支持稀疏张量
cat()
dstack()
empty()
empty_like()
hstack()
index_select()
is_complex()
is_floating_point()
is_nonzero()
is_same_size()
is_signed()
is_tensor()
lobpcg()
mm()
native_norm()
pca_lowrank()
select()
stack()
svd_lowrank()
unsqueeze()
vstack()
zeros()
zeros_like()
要管理稀疏张量不变性的检查，请参阅
用于控制检查稀疏张量不变性的工具。 |
要将稀疏张量与 gradcheck() 函数一起使用，请参阅
装饰函数，以扩展稀疏张量的 gradcheck。 |
一元函数¶
我们的目标是支持所有保留零的一元函数。
如果您发现我们缺少您需要的一个保留零的一元函数，请随时提出功能请求问题。在提出问题之前，请务必先尝试使用搜索功能。
以下运算符目前支持稀疏 COO/CSR/CSC/BSR/CSR 张量输入。
abs()
asin()
asinh()
atan()
atanh()
ceil()
conj_physical()
floor()
log1p()
neg()
round()
sin()
sinh()
sign()
sgn()
signbit()
tan()
tanh()
trunc()
expm1()
sqrt()
angle()
isinf()
isposinf()
isneginf()
isnan()
erf()
erfinv()
