评价此页

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#

使用指定的二维块在给定的 crow_indicescol_indices 处构造一个 BSR (块压缩行) 格式的稀疏张量。BSR 格式的稀疏矩阵乘法操作通常比 COO 格式的稀疏张量更快。请务必参考 关于索引数据类型的说明

注意

如果未指定 device 参数,则给定的 values 和 indices 张量必须在同一设备上。然而,如果指定了该参数,输入张量将转换为给定的设备,进而决定构造的稀疏张量的设备。

参数
  • crow_indices (array_like) – 大小为 (*batchsize, nrowblocks + 1) 的 (B+1) 维数组。每个批次的最后一个元素是非零元素的数量。这个张量根据给定行块的起始位置,编码了 values 和 col_indices 中的块索引。张量中的每个连续数字减去它前面的数字,表示给定行中块的数量。

  • col_indices (array_like) – values 中每个块的列块坐标。(B+1) 维张量,长度与 values 相同。

  • values (array_list) – 张量的初始值。可以是列表、元组、NumPy ndarray、标量以及其他表示 (1 + 2 + K) 维张量的类型,其中 K 是密集维度的数量。

  • size (list, tuple, torch.Size, optional) – 稀疏张量的大小:(*batchsize, nrows * blocksize[0], ncols * blocksize[1], *densesize),其中 blocksize == values.shape[1:3]。如果未提供,则大小将推断为足以容纳所有非零块的最小尺寸。

关键字参数
  • dtype (torch.dtype, optional) – 返回张量的所需数据类型。默认值:如果为 None,则从 values 推断数据类型。

  • device (torch.device, optional) – 返回张量的所需设备。默认值:如果为 None,则使用当前默认张量类型的设备(请参阅 torch.set_default_device())。对于 CPU 张量类型,device 将是 CPU,对于 CUDA 张量类型,它将是当前 CUDA 设备。

  • pin_memory (bool, optional) – 如果设置为 True,则返回的张量将被分配到固定内存中。仅适用于 CPU 张量。默认值:False

  • requires_grad (bool, optional) – 如果 autograd 应记录在返回的张量上的操作。默认值: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)