Table of Contents
Shortcuts

torch.sparse_compressed_tensor

torch.sparse_compressed_tensor(compressed_indices, plain_indices, values, size=None, *, dtype=None, layout=None, device=None, requires_grad=False, check_invariants=None) → 张量

构建一个压缩稀疏格式 - CSR、CSC、BSR 或 BSC - 的稀疏张量，并在给定的 compressed_indices 和 plain_indices 处指定值。压缩稀疏格式中的稀疏矩阵乘法操作通常比 COO 格式中的稀疏张量操作更快。请查看关于索引数据类型的说明。

注意

如果未指定 device 参数，则给定的 values 和索引张量的设备必须匹配。然而，如果指定了该参数，输入张量将被转换到指定的设备，并由此确定构造的稀疏张量的设备。

Parameters

  • compressed_indices (array_like) – (B+1)-维数组，大小为 (*batchsize, compressed_dim_size + 1)。 每个批次的最后一个元素是 非零元素或块的数量。此张量编码了在 values 和 plain_indices 中的索引， 取决于给定的压缩维度（行或列）的起始位置。张量中每个连续的数字减去前一个数字表示在给定压缩维度中的元素或块的数量。

  • plain_indices (array_like) – 每个元素或值中块的普通维度（列或行）坐标。(B+1)维张量，长度与值相同。

  • 值 (数组列表) – 张量的初始值。可以是列表、元组、NumPy ndarray、标量和其他类型，表示一个（1+K）维（对于CSR和CSC布局）或（1+2+K）维张量（对于BSR和BSC布局），其中K是密集维度的数量。

  • size（列表，元组，torch.Size，可选）– 稀疏张量的大小：(*batchsize, nrows * blocksize[0], ncols * blocksize[1], *densesize) 其中 blocksize[0] == blocksize[1] == 1 用于 CSR 和 CSC 格式。如果未提供， 大小将被推断为足以容纳所有非零元素或块的最小大小。

Keyword Arguments

  • dtype (torch.dtype, 可选) – 返回张量的所需数据类型。默认值：如果为 None，则从 values 推断数据类型。

  • 布局 (torch.layout, 必需) – 返回张量的所需布局：torch.sparse_csr, torch.sparse_csc, torch.sparse_bsr, 或 torch.sparse_bsc。

  • 设备 (torch.device, 可选) – 返回张量所需的设备。默认值：如果为 None，则使用默认张量类型的当前设备（参见 torch.set_default_device()）。device 将是 CPU 张量类型的 CPU，以及 CUDA 张量类型的当前 CUDA 设备。

  • requires_grad (布尔值, 可选) – 如果 autograd 应该记录对返回张量的操作。默认值：False。

  • check_invariants (bool, 可选) – 如果检查稀疏张量不变量。 默认值：由 torch.sparse.check_sparse_tensor_invariants.is_enabled() 返回， 最初为 False。

Example::
>>> compressed_indices = [0, 2, 4]
>>> plain_indices = [0, 1, 0, 1]
>>> values = [1, 2, 3, 4]
>>> torch.sparse_compressed_tensor(torch.tensor(compressed_indices, dtype=torch.int64),
...                                torch.tensor(plain_indices, dtype=torch.int64),
...                                torch.tensor(values), dtype=torch.double, layout=torch.sparse_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, layout=torch.sparse_csr)