torch.sparse_coo_tensor

torch.sparse_coo_tensor(indices, values, size=None, *, dtype=None, device=None, pin_memory=False, requires_grad=False, check_invariants=None, is_coalesced=None) → Tensor

使用给定indices处的指定值构建COO（坐标）格式的稀疏张量。

注意

当is_coalesced未指定或为None时，此函数返回未合并的张量。

注意

如果未指定device参数，则给定values和索引张量(s)的设备必须匹配。但是，如果指定了该参数，则输入张量将转换为给定设备，进而确定所构建的稀疏张量的设备。

参数

• indices (array_like) – 张量的初始数据。可以是列表、元组、NumPy ndarray、标量和其他类型。将在内部转换为torch.LongTensor。索引是矩阵中非零值的坐标，因此应为二维，其中第一维是张量维数，第二维是非零值的个数。

• values (array_like) – 张量的初始值。可以是列表、元组、NumPy ndarray、标量和其他类型。

• size (list, tuple, 或 torch.Size, 可选) – 稀疏张量的尺寸。如果未提供，则尺寸将被推断为足以容纳所有非零元素的最小尺寸。

关键字参数

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

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

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

• requires_grad (bool, 可选) – 是否应记录返回张量上的操作。默认值：False。

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

• is_coalesced (bool, 可选) – 当``True``时，调用者负责提供与合并张量相对应的张量索引。如果check_invariants标志为False，则如果未满足先决条件，则不会引发错误，这将导致结果错误且不会发出警告。要强制合并，请在结果张量上使用coalesce()。默认值：None：除了琐碎的情况（例如 nnz < 2）之外，结果张量的 is_coalesced 设置为False`。

示例

>>> i = torch.tensor([[0, 1, 1],
...                   [2, 0, 2]])
>>> v = torch.tensor([3, 4, 5], dtype=torch.float32)
>>> torch.sparse_coo_tensor(i, v, [2, 4])
tensor(indices=tensor([[0, 1, 1],
                       [2, 0, 2]]),
       values=tensor([3., 4., 5.]),
       size=(2, 4), nnz=3, layout=torch.sparse_coo)

>>> torch.sparse_coo_tensor(i, v)  # Shape inference
tensor(indices=tensor([[0, 1, 1],
                       [2, 0, 2]]),
       values=tensor([3., 4., 5.]),
       size=(2, 3), nnz=3, layout=torch.sparse_coo)

>>> torch.sparse_coo_tensor(i, v, [2, 4],
...                         dtype=torch.float64,
...                         device=torch.device('cuda:0'))
tensor(indices=tensor([[0, 1, 1],
                       [2, 0, 2]]),
       values=tensor([3., 4., 5.]),
       device='cuda:0', size=(2, 4), nnz=3, dtype=torch.float64,
       layout=torch.sparse_coo)

# Create an empty sparse tensor with the following invariants:
#   1. sparse_dim + dense_dim = len(SparseTensor.shape)
#   2. SparseTensor._indices().shape = (sparse_dim, nnz)
#   3. SparseTensor._values().shape = (nnz, SparseTensor.shape[sparse_dim:])
#
# For instance, to create an empty sparse tensor with nnz = 0, dense_dim = 0 and
# sparse_dim = 1 (hence indices is a 2D tensor of shape = (1, 0))
>>> S = torch.sparse_coo_tensor(torch.empty([1, 0]), [], [1])
tensor(indices=tensor([], size=(1, 0)),
       values=tensor([], size=(0,)),
       size=(1,), nnz=0, layout=torch.sparse_coo)

# and to create an empty sparse tensor with nnz = 0, dense_dim = 1 and
# sparse_dim = 1
>>> S = torch.sparse_coo_tensor(torch.empty([1, 0]), torch.empty([0, 2]), [1, 2])
tensor(indices=tensor([], size=(1, 0)),
       values=tensor([], size=(0, 2)),
       size=(1, 2), nnz=0, layout=torch.sparse_coo)