評價此頁

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(rdinate) 格式稀疏張量

注意

is_coalesced 未指定或為 None 時,此函式將返回一個 未合併的張量

注意

如果未指定 device 引數,則給定的 values 和 indices 張量必須在同一裝置上。然而,如果指定了該引數,輸入張量將轉換為給定的裝置,進而決定構造的稀疏張量的裝置。

引數
  • indices (array_like) – 張量的初始資料。可以是列表、元組、NumPy ndarray、標量和其他型別。將被內部強制轉換為 torch.LongTensor。indices 是矩陣中非零值的座標,因此應為二維的,其中第一維是張量的維度數,第二維是非零值的數量。

  • values (array_like) – 張量的初始值。可以是列表、元組、NumPy ndarray、標量和其他型別。

  • size (list, tuple, or torch.Size, optional) – 稀疏張量的大小。如果未提供,則大小將推斷為足以容納所有非零元素的最小尺寸。

關鍵字引數
  • 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。

  • is_coalesced (bool, optional) – 當設定為 ``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)