torch.sparse_bsr_tensor

torch.sparse_bsr_tensor(crow_indices, col_indices, values, size=None, *, dtype=None, device=None, pin_memory=False, requires_grad=False, check_invariants=None)) → Tensor

构建一个BSR（块压缩稀疏行）格式的稀疏张量，并在给定的crow_indices和col_indices位置指定2维块。在BSR格式下进行稀疏矩阵乘法操作通常比在COO格式下的稀疏张量更快。请参阅关于索引数据类型的说明。

注意

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

参数

crow_indices (array_like) – 尺寸为 (*batchsize, nrowblocks + 1) 的 (B+1) 维数组。每个批次的最后一个元素表示非零值的数量。此张量根据给定行块开始的位置，编码了 values 和 col_indices 中的块索引。张量中连续数字之间的差值表示给定行中的块数。
col_indices (array_like) – 表示每个值块的列块坐标的 (B+1) 维张量，其长度与 values 相同。
values (array_list) – 张量的初始值。可以是列表、元组、NumPy ndarray、标量或其他表示 (1 + 2 + K) 维张量的类型，其中K 是稠密维度的数量。
size (列表、元组或torch.Size，可选) – 稀疏张量的尺寸： (*batchsize, nrows * blocksize[0], ncols * blocksize[1], *densesize) 其中blocksize == values.shape[1:3]。如果没有提供，则大小将被推断为足以容纳所有非零块的最小尺寸。

关键字参数

dtype (torch.dtype, 可选) – 返回的张量的数据类型。默认情况下，如果为 None，则根据 values 推断数据类型。
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。

示例:

>>> crow_indices = [0, 1, 2]
>>> col_indices = [0, 1]
>>> values = [[[1, 2], [3, 4]], [[5, 6], [7, 8]]]
>>> torch.sparse_bsr_tensor(torch.tensor(crow_indices, dtype=torch.int64),
...                         torch.tensor(col_indices, dtype=torch.int64),
...                         torch.tensor(values), dtype=torch.double)
tensor(crow_indices=tensor([0, 1, 2]),
       col_indices=tensor([0, 1]),
       values=tensor([[[1., 2.],
                       [3., 4.]],
                      [[5., 6.],
                       [7., 8.]]]), size=(2, 2), nnz=2, dtype=torch.float64,
       layout=torch.sparse_bsr)