torch.sparse_csc_tensor

• 以CSC格式构建一个稀疏张量。CSC格式的稀疏张量乘法运算通常比 COO 格式的稀疏张量更快。
  • CSC格式（Compressed Sparse Column Format）是一种存储稀疏矩阵的常用格式，它通过三个数组来表示稀疏矩阵：
    非零元素数组（values）：矩阵中的非零值，按列优先顺序排列。
    行索引数组（row_indices）：矩阵中非零值所在行的索引
    列指针数组（ccol_indices）：每列第一个非零值在values中的索引。最后一个元素是非零值的总个数。
    假设我们有一个5x5的稀疏矩阵A，如下所示：
    $$\left[\begin{array}{ccccc}0& 0& 1& 0& 0\\ 2& 0& 0& 3& 0\\ 0& 4& 0& 0& 0\\ 0& 0& 0& 0& 5\\ 6& 0& 7& 0& 0\end{array}\right]$$
    ​CSR格式数据为：
    values = [2, 6, 4, 1, 7, 3, 5]
    row_indices= [1, 4, 2, 0, 4, 1, 3]
    ccol_indices= [0, 2, 3, 5, 6, 7]
    • 解释：
      values = [2, 6, 4, 1, 7, 3, 5]
      列优先顺序存储所有非零元素的值，顺序与行索引数组row_indices对应。
      row_indices= [1, 4, 2, 0, 4, 1, 3]
      第1列的第1个非零元素是2，行下标为1，所以第1个元素是1；（下标从0开始,，故“第0行”实际上是第一行）
      第1列的第2个非零元素是6，行下标为4，所以第2个元素是4；
      第2列的第1个非零元素是4，行下标为2，所以第3个元素是2；
      第3列的第1个非零元素是1，行下标为0，所以第4个元素是0；
      第3列的第2个非零元素是7，行下标为4，所以第5个元素是4；
      第4列的第1个非零元素是3，行下标为1，所以第6个元素是1；
      第5列的第1个非零元素是5，行下标为3，所以第7个元素是3；
      ccol_indices= [0, 2, 3, 5, 6, 7]
      第1列的第一个非零元素2，在values中的下标是0，所以这里是0；
      第2列的第一个非零元素4，在values中的下标是2，所以这里是2；
      第3列的第一个非零元素1，在values中的下标是3，所以这里是3；
      第4列的第一个非零元素3，在values中的下标是5，所以这里是5；
      第5列的第一个非零元素5，在values中的下标是6，所以这里是6；
      共有7个非零元素[2, 6, 4, 1, 7, 3, 5]，故最后一个数是7

torch.sparse_csc_tensor(ccol_indices, row_indices, values, size=None, *, dtype=None, device=None, pin_memory=False, requires_grad=False, check_invariants=None) → Tensor

参数

• ccol_indices （array_like） - （B+1） 维数组 （*batchsize， ncols + 1） 的每个批次的最后一个元素是非零的数量。每列第一个非零值在values中的索引。最后一个元素是非零值的总个数。相邻数字的差值，表示给定列中元素的数量。
• row_indices （array_like） – values数组中每个元素的行坐标。长度与 values 相同。
• values (array_list) – 张量的初始值。可以是列表、元组、NumPy ndarray、标量和其他类型
• size （list， tuple， torch.Size， optional） – 稀疏张量的大小： (*batchsize, nrows, ncols, *densesize) .如果未提供，则大小将被推断为足够大的最小大小，以容纳所有非零元素。

关键字参数

• dtype（torch.dtype，可选） – 返回张量的所需数据类型。默认值：如果为 None，则从值推断数据类型。
• device （torch.device，可选） – 返回的张量的所需设备。默认值：如果为 None，则使用当前设备作为默认张量类型（请参阅 torch.set_default_device（） ）。device 将是 CPU 张量类型的 CPU，CUDA 张量类型的当前 CUDA 设备。
• pin_memory （bool，可选） – 如果设置，则返回的张量将在固定内存中分配。仅适用于 CPU 张量。默认值：False。可以使用 .to(‘cuda’) 方法将数据从固定内存移动到 GPU，通常比从常规内存移动到 GPU 更快。
• requires_grad （bool， 可选） – 如果 autograd 应记录对返回的张量的操作。默认值：False。
• check_invariants （bool， 可选） – 是否选中稀疏张量不变性。默认值：False（由 torch.sparse.check_sparse_tensor_invariants.is_enabled() 得到）
  • 不变性检查是一种验证机制，用于确保稀疏张量的数据结构和逻辑是正确的。如：压缩稀疏行（CSR）格式中的一个不变性条件，即crow_indices数组的最后一个元素必须等于非零元素的数量（nnz）。

示例代码

import torch
values = [2, 6, 4, 1, 7, 3, 5]
row_indices= [1, 4, 2, 0, 4, 1, 3]
ccol_indices= [0, 2, 3, 5, 6, 7]
x = torch.sparse_csc_tensor(torch.tensor(ccol_indices, dtype=torch.int64),torch.tensor(row_indices, dtype=torch.int64),torch.tensor(values), dtype=torch.double)# 打印稀疏张量x
print(f'x=\n{x}')# 将稀疏张量x转换为稠密矩阵形式并打印
print(f'x的稠密矩阵形式=\n{x.to_dense()}')
'''output
x=
tensor(ccol_indices=tensor([0, 2, 3, 5, 6, 7]),row_indices=tensor([1, 4, 2, 0, 4, 1, 3]),values=tensor([2., 6., 4., 1., 7., 3., 5.]), size=(5, 5), nnz=7,dtype=torch.float64, layout=torch.sparse_csc)
x的稠密矩阵形式=
tensor([[0., 0., 1., 0., 0.],[2., 0., 0., 3., 0.],[0., 4., 0., 0., 0.],[0., 0., 0., 0., 5.],[6., 0., 7., 0., 0.]], dtype=torch.float64)
'''