torch.sparse_bsr_tensor

torch.sparse_bsr_tensor(crow_indices, col_indices, values, size=None, *, dtype=None, device=None, pin_memory=False, requires_grad=False, check_invariants=None) → Tensor

Создает разреженный тензор в формате BSR (блочное сжатое разреженное построчное представление) с указанными двумерными блоками по заданным crow_indices и col_indices. Операции умножения разреженных матриц в формате BSR обычно выполняются быстрее, чем для разреженных тензоров в формате COO. Обратите внимание на примечание о типе данных индексов.

Примечание

Если аргумент device не указан, устройство заданного values и тензора (тензоров) индексов должно совпадать. Однако, если аргумент указан, входные тензоры будут преобразованы к заданному устройству, которое, в свою очередь, определит устройство созданного разреженного тензора.

Параметры:

• crow_indices (array_like) – Массив размерности (B+1) и размера (*batchsize, nrowblocks + 1). Последний элемент каждого пакета — количество ненулевых элементов. Этот тензор кодирует индекс блока в values и col_indices в зависимости от того, с какого места начинается заданный блок строк. Разность каждого последующего числа в тензоре и предыдущего числа обозначает количество блоков в данной строке.
• col_indices (array_like) – Координаты блоков столбцов для каждого блока в values. Тензор размерности (B+1), имеющий ту же длину, что и values.
• values (array_list) – Начальные значения тензора. Может быть списком, кортежем, массивом NumPy ndarray, скаляром или другим типом, представляющим тензор размерности (1 + 2 + K), где K — количество плотных измерений.
• size (list, tuple, torch.Size, необязательно) – Размер разреженного тензора: (*batchsize, nrows * blocksize[0], ncols * blocksize[1], *densesize), где blocksize == values.shape[1:3]. Если не указан, размер будет выведен как минимальный размер, достаточный для хранения всех ненулевых блоков.

Именованные аргументы:

• dtype (torch.dtype, необязательно) – требуемый тип данных возвращаемого тензора. По умолчанию: если None, тип данных выводится из values.
• device (torch.device, необязательно) – требуемое устройство возвращаемого тензора. По умолчанию: если None, используется текущее устройство для типа тензора по умолчанию (см. torch.set_default_device()). Значением device будет CPU для типов тензоров CPU и текущее устройство CUDA для типов тензоров CUDA.
• pin_memory (bool, необязательно) – Если задано, возвращаемый тензор будет размещен в закрепленной памяти. Работает только для тензоров CPU. По умолчанию: False.
• requires_grad (bool, необязательно) – Нужно ли autograd записывать операции над возвращаемым тензором. По умолчанию: False.
• check_invariants (bool, необязательно) – Проверяются ли инварианты разреженного тензора. По умолчанию: значение, возвращаемое torch.sparse.check_sparse_tensor_invariants.is_enabled(); изначально False.

Пример:

>>> crow_indices = [0, 1, 2]
>>> col_indices = [0, 1]
>>> values = [[[1, 2], [3, 4]], [[5, 6], [7, 8]]]
>>> torch.sparse_bsr_tensor(torch.tensor(crow_indices, dtype=torch.int64),
...                         torch.tensor(col_indices, dtype=torch.int64),
...                         torch.tensor(values), dtype=torch.double)
tensor(crow_indices=tensor([0, 1, 2]),
       col_indices=tensor([0, 1]),
       values=tensor([[[1., 2.],
                       [3., 4.]],
                      [[5., 6.],
                       [7., 8.]]]), size=(2, 2), nnz=2, dtype=torch.float64,
       layout=torch.sparse_bsr)