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 来控制结果布局，并认识到这是一个重要的功能，可以为任何给定模型规划更优化的执行路径。
稀疏半结构化张量¶
警告
稀疏半结构化张量目前是一个原型功能，可能会发生变化。如果您有任何错误报告或反馈，请随时提出 issue。
半结构化稀疏性是一种稀疏数据布局，最初在 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 ) 且元素类型为torch.int16（如果 dtype 为 torch.float16 或 torch.bfloat16）或元素类型为torch.int32（如果 dtype 为 torch.int8）的元数据掩码。
对于 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(dense, sparse)
torch.mm(sparse, dense)
aten.linear.default(dense, sparse, bias)
aten.t.default(sparse)
aten.t.detach(sparse)
要使用这些操作，只需传递 to_sparse_semi_structured(tensor) 的输出，而不是在您的张量以半结构化稀疏格式包含 0 时使用 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 + <size of element type in bytes>) * nse 字节（加上存储其他张量数据的常数开销）。
步幅张量的内存消耗至少为 product(<tensor shape>) * <size of element type in bytes>。
例如，一个 10 000 x 10 000 的张量，其中有 100 000 个非零的 32 位浮点数，当使用 COO 张量布局时，其内存消耗至少为 (2 * 8 + 4) * 100 000 = 2 000 000 字节，当使用默认的步幅张量布局时，其内存消耗为 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，从而得到一个一维未合并的张量
>>> 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 成立。稀疏压缩张量的稀疏维度数量始终为 2，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 维数组。同样，对于块稀疏压缩布局，二维块被视为正在指定的元素。以一个三维块稀疏张量为例，它有一个长度为 b 的批处理维度，以及一个块形状 p, q。如果此张量有 n 个指定元素，那么实际上我们每个批处理有 n 个块指定。此张量将具有形状为 (b, n, p, q) 的 values。指定元素数量的这种解释来自所有稀疏压缩布局都源自二维矩阵的压缩。批处理维度被视为稀疏矩阵的堆叠，稠密维度将元素的含义从简单的标量值更改为具有自身维度的数组。
稀疏 CSR 张量¶
与COO格式相比，CSR格式的主要优势在于更好地利用存储空间，并且可以显著加快计算操作，例如使用MKL和MAGMA后端进行稀疏矩阵向量乘法。
在最简单的情况下，一个(0 + 2 + 0)维的稀疏CSR张量由三个1维张量组成：crow_indices、col_indices和values。
crow_indices张量包含压缩的行索引。这是一个大小为nrows + 1（行数加1）的1维张量。crow_indices的最后一个元素是指定元素的数量，nse。此张量根据给定行开始的位置，编码values和col_indices中的索引。张量中每个连续数字减去它前面的数字表示给定行中的元素数量。
col_indices张量包含每个元素的列索引。这是一个大小为nse的1维张量。
values张量包含CSR张量元素的值。这是一个大小为nse的1维张量。
注意
索引张量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张量构建二维稀疏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（压缩稀疏列）张量格式实现了CSC格式，用于存储二维张量，并扩展为支持稀疏CSC张量的批次，以及多维张量作为值。
注意
当转置涉及交换稀疏维度时，稀疏CSC张量本质上是稀疏CSR张量的转置。
与稀疏CSR张量类似，稀疏CSC张量由三个张量组成：ccol_indices、row_indices和values。
ccol_indices张量包含压缩的列索引。这是一个形状为(*batchsize, ncols + 1)的(B + 1)维张量。最后一个元素是指定元素的数量，nse。此张量根据给定列开始的位置，编码values和row_indices中的索引。张量中每个连续数字减去它前面的数字表示给定列中的元素数量。
row_indices张量包含每个元素的行索引。这是一个形状为(*batchsize, nse)的(B + 1)维张量。
values张量包含CSC张量元素的值。这是一个形状为(nse, *densesize)的(1 + K)维张量。
CSC张量的构建¶
可以使用torch.sparse_csc_tensor()函数直接构建稀疏CSC张量。用户必须分别提供行和列索引以及值张量，其中列索引必须使用CSR压缩编码指定。size参数是可选的，如果不存在，则将根据row_indices和ccol_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张量由压缩的行索引组成。这是一个 (B + 1) 维的张量，形状为(*batchsize, nrowblocks + 1)。最后一个元素是指定块的数量，nse。此张量根据给定列块的起始位置，对values和col_indices中的索引进行编码。张量中每个连续数字减去它前面的数字，表示给定行中块的数量。
col_indices张量包含每个元素的列块索引。这是一个 (B + 1) 维的张量，形状为(*batchsize, nse)。
values张量包含稀疏 BSR 张量元素的值，这些值被收集到二维块中。这是一个 (1 + 2 + K) 维的张量，形状为(nse, nrowblocks, ncolblocks, *densesize)。
BSR 张量的构造¶
可以使用 torch.sparse_bsr_tensor() 函数直接构造稀疏 BSR 张量。用户必须分别提供行和列块索引以及值张量，其中行块索引必须使用 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张量由压缩的列索引组成。这是一个 (B + 1) 维的张量，形状为(*batchsize, ncolblocks + 1)。最后一个元素是指定块的数量，nse。此张量根据给定行块的起始位置，对values和row_indices中的索引进行编码。张量中每个连续数字减去它前面的数字，表示给定列中块的数量。
row_indices张量包含每个元素的行块索引。这是一个 (B + 1) 维的张量，形状为(*batchsize, nse)。
values张量包含稀疏 BSC 张量元素的值，这些值被收集到二维块中。这是一个 (1 + 2 + K) 维的张量，形状为(nse, nrowblocks, ncolblocks, *densesize)。
BSC 张量的构造¶
可以使用 torch.sparse_bsc_tensor() 函数直接构造稀疏 BSC 张量。用户必须分别提供行和列块索引以及值张量，其中列块索引必须使用 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 编码；以及所谓的普通索引，与压缩索引正交。这使得这些张量上的各种工具可以共享相同的实现，这些实现由张量布局参数化。
稀疏压缩张量的构造¶
可以使用 torch.sparse_compressed_tensor() 函数构造稀疏 CSR、CSC、BSR 和 CSC 张量，该函数与上面讨论的构造函数 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] 表示矩阵（二维 PyTorch 张量），V[layout] 表示向量（一维 PyTorch 张量）。此外，f 表示标量（浮点数或 0 维 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 张量 的值张量。 |
以下张量方法特定于稀疏 COO 张量
如果 |
|
将 |
|
从 稀疏张量 |
|
如果 |
|
返回 稀疏 COO 张量 的索引张量。 |
当 |
|
当 |
以下张量方法支持稀疏 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()
