torch.sparse_compressed_tensor

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

构建一个以压缩稀疏格式（CSR、CSC、BSR 或 BSC）表示的稀疏张量，并在给定的 compressed_indices 和 plain_indices 处指定值。与 COO 格式的稀疏张量相比，在压缩稀疏格式下进行稀疏矩阵乘法操作通常更快。请参阅关于索引数据类型的注意事项。

注意

如果没有指定 device 参数，那么给定的 values 和索引张量必须具有相同的设备。如果指定了参数，则输入张量会被转换到指定的设备，并且会确定构造出来的稀疏张量的设备。

参数

compressed_indices (array_like) – 尺寸为 (*batchsize, compressed_dim_size + 1) 的 (B+1) 维数组。每个批次的最后一个元素表示非零元素或块的数量。此张量编码了在values 和 plain_indices 中给定压缩维度（行或列）开始的位置索引。张量中连续数字之间的差值表示每个压缩维度中的元素或块数量。
plain_indices (array_like) – 表示值数组中每个元素或块的平面维度（行或列）坐标。这是一个与 values 长度相同的 (B+1) 维张量。
values (array_list) – 张量的初始值。可以是列表、元组、NumPy ndarray 或标量等类型，表示一个（1+K）维张量（对于CSR和CSC布局），或（1+2+K）维张量（对于BSR和BSC布局）。其中K是密集维度的数量。
size (列表、元组、torch.Size，可选) – 稀疏张量的大小： (*batchsize, nrows * blocksize[0], ncols * blocksize[1], *densesize)。对于 CSR 和 CSC 格式，blocksize[0] == blocksize[1] == 1。如果没有提供，则大小将被推断为能够容纳所有非零元素或块的最小值。

关键字参数

dtype (torch.dtype, 可选) – 返回的张量的数据类型。默认情况下，如果为 None，则根据 values 推断数据类型。
layout (torch.layout, 必填) – 返回张量的所需布局： torch.sparse_csr、torch.sparse_csc、torch.sparse_bsr 或 torch.sparse_bsc。
device (torch.device, 可选) – 返回张量所需的设备。默认情况下，如果未指定设备，则使用当前的默认张量类型设备（参见 torch.set_default_device())。对于 CPU 张量类型，默认设备为 CPU；对于 CUDA 张量类型，默认设备为当前的 CUDA 设备。
pin_memory (bool, 可选) – 如果启用，返回的张量将在固定内存中分配。仅适用于 CPU 张量。默认值： False。
requires_grad (bool, optional) – 是否启用自动求导记录返回的张量上的操作。默认值：False。
check_invariants (bool, optional) – 是否检查稀疏张量的不变性。默认值由 torch.sparse.check_sparse_tensor_invariants.is_enabled() 返回，初始为 False。

示例:

>>> 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)