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 是密集维度的数量。

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

关键字参数:

• 数据类型（ 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 设备。

• pin_memory (bool，可选) – 如果设置，返回的张量将在固定内存中分配。仅适用于 CPU 张量。默认： False 。

• requires_grad (bool，可选) – 如果 autograd 应记录对返回张量的操作。默认： False 。

• 检查不变量（bool，可选）- 如果检查稀疏张量不变量。默认：由 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)