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 — CSR, CSC, BSR или BSC — с указанными значениями в заданных compressed_indices и plain_indices. Операции умножения разреженных матриц в формате Compressed Sparse обычно выполняются быстрее, чем для разреженных тензоров в формате 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) – Следует ли 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)