評價此頁

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#

構造一個具有指定 compressed_indicesplain_indicesCompressed Sparse 格式(CSR、CSC、BSR 或 BSC)的稀疏張量。Compressed Sparse 格式的稀疏矩陣乘法運算通常比 COO 格式的稀疏張量更快。請參閱 關於索引資料型別的說明

注意

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

引數
  • compressed_indices (array_like) – (B+1) 維陣列,大小為 (*batchsize, compressed_dim_size + 1)。每個批次的最後一個元素是非零元素或塊的數量。此張量根據給定壓縮維度(行或列)的起始位置,編碼 valuesplain_indices 中的索引。張量中的每個連續數字減去其前面的數字,表示給定壓縮維度中元素或塊的數量。

  • plain_indices (array_like) – values 中每個元素或塊的平面維度(列或行)座標。(B+1) 維張量,長度與 values 相同。

  • values (array_list) – 張量的初始值。可以是列表、元組、NumPy ndarray、標量和其他表示 (1+K) 維(對於 CSR 和 CSC 佈局)或 (1+2+K) 維張量(對於 BSR 和 BSC 佈局)的型別,其中 K 是密集維度的數量。

  • size (list, tuple, torch.Size, optional) – 稀疏張量的大小:(*batchsize, nrows * blocksize[0], ncols * blocksize[1], *densesize),其中對於 CSR 和 CSC 格式,blocksize[0] == blocksize[1] == 1。如果未提供,則推斷大小為足以容納所有非零元素或塊的最小尺寸。

關鍵字引數
  • dtype (torch.dtype, optional) – 返回張量的所需資料型別。預設值:如果為 None,則從 values 推斷資料型別。

  • layout (torch.layout, required) – 返回張量的期望佈局:torch.sparse_csrtorch.sparse_csctorch.sparse_bsrtorch.sparse_bsc

  • 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。

示例

>>> 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)