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 Sparse format)的稀疏張量 - CSR、CSC、BSR 或 BSC -,並在給定的
compressed_indices
和plain_indices
中指定數值。壓縮稀疏格式的稀疏矩陣乘法運算通常比 COO 格式的稀疏張量更快。請務必參考關於索引資料類型的說明。注意
如果未指定
device
參數,則給定的values
和索引張量的裝置必須一致。但是,如果指定了該參數,則輸入張量將被轉換為給定的裝置,進而決定所建構的稀疏張量的裝置。- 參數
compressed_indices (array_like) – (B+1) 維陣列,大小為
(*batchsize, compressed_dim_size + 1)
。每個批次的最後一個元素是非零元素或區塊的數量。此張量根據給定的壓縮維度(行或列)的起始位置,對values
和plain_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)
,其中blocksize[0] == blocksize[1] == 1
用於 CSR 和 CSC 格式。 如果未提供,則大小將推斷為足以容納所有非零元素或塊的最小尺寸。
- 關鍵字參數
dtype (
torch.dtype
, optional) – 返回張量的所需資料類型。預設值:如果為 None,則從values
推斷資料類型。layout (
torch.layout
, required) – 返回張量的所需佈局:torch.sparse_csr
、torch.sparse_csc
、torch.sparse_bsr
或torch.sparse_bsc
。device (
torch.device
, optional) – 返回張量的所需裝置。預設值:如果為 None,則使用預設張量類型的當前裝置(請參閱torch.set_default_device()
)。device
對於 CPU 張量類型將為 CPU,對於 CUDA 張量類型將為當前 CUDA 裝置。pin_memory (bool, optional) – 如果設定,返回的張量將分配在釘選記憶體中。僅適用於 CPU 張量。預設值:
False
。requires_grad (bool, optional) – 是否應在返回的張量上記錄自動微分操作。預設值:
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)