torch.lu

torch.lu(*args, **kwargs)

Вычисляет LU-разложение матрицы или набора матриц A. Возвращает кортеж, содержащий LU-разложение и перестановки A. Перестановки выполняются, если pivot установлено в True.

Предупреждение

torch.lu() устарело и рекомендуется использовать torch.linalg.lu_factor() и torch.linalg.lu_factor_ex(). torch.lu() будет удалена в будущих выпусках PyTorch. LU, pivots, info = torch.lu(A, compute_pivots) следует заменить на

LU, pivots = torch.linalg.lu_factor(A, compute_pivots)

LU, pivots, info = torch.lu(A, compute_pivots, get_infos=True) следует заменить на

LU, pivots, info = torch.linalg.lu_factor_ex(A, compute_pivots)

Примечание

• Возвращаемая матрица перестановок для каждой матрицы в наборе представлена 1-индексированным вектором размера min(A.shape[-2], A.shape[-1]). pivots[i] == j указывает, что на i шаге алгоритма i строка была переставлена со j-1 строкой.
• LU-разложение с pivot = False недоступно для CPU, и попытка выполнить его приведет к ошибке. Однако LU-разложение с pivot = False доступно для CUDA.
• Данная функция не проверяет успешность разложения, если get_infos равно True, поскольку информация о статусе разложения находится в третьем элементе возвращаемого кортежа.
• В случае наборов квадратных матриц размером не более 32 на устройстве CUDA LU-разложение повторяется для сингулярных матриц из-за ошибки в библиотеке MAGMA (см. проблему MAGMA 13).
• L, U, и P можно получить с помощью torch.lu_unpack().

Предупреждение

Градиенты этой функции будут конечными только когда A имеет полный ранг. Это связано с тем, что LU-разложение дифференцируемо только для матриц с полным рангом. Кроме того, если A близка к тому, чтобы не иметь полный ранг, градиент будет численно неустойчив, поскольку он зависит от вычисления $L^{-1}$ и $U^{-1}$.

Параметры:

• A (Тензор) – тензор для разложения размером $(*, m, n)$
• pivot (bool, необязательно) – управляет выполнением перестановки. Значение по умолчанию: True
• get_infos (bool, необязательно) – если установлено в True, возвращает IntTensor с информацией. Значение по умолчанию: False
• out (кортеж, необязательно) – необязательный выходной кортеж. Если get_infos равно True, элементы кортежа — Tensor, IntTensor и IntTensor. Если get_infos равно False, элементы кортежа — Tensor и IntTensor. Значение по умолчанию: None

Возвращаемые значения:

Кортеж тензоров, содержащий:

• разложение (Тензор): разложение размером $(*, m, n)$
• перестановки (IntTensor): перестановки размером $(*, \text{min}(m, n))$. pivots хранит все промежуточные перестановки строк. Конечная перестановка perm может быть восстановлена применением swap(perm[i], perm[pivots[i] - 1]) для i = 0, ..., pivots.size(-1) - 1, где perm изначально представляет собой тождественную перестановку из $m$ элементов (суть того, что делает torch.lu_unpack()).
• infos (IntTensor, необязательно): если get_infos равно True, это тензор размера $(*)$, где ненулевые значения указывают на успешность или неудачу разложения для каждой матрицы или каждого набора матриц.

Тип возвращаемого значения:

(Тензор, IntTensor, IntTensor (необязательно))

Пример:

>>> A = torch.randn(2, 3, 3)
>>> A_LU, pivots = torch.lu(A)
>>> A_LU
tensor([[[ 1.3506,  2.5558, -0.0816],
         [ 0.1684,  1.1551,  0.1940],
         [ 0.1193,  0.6189, -0.5497]],

        [[ 0.4526,  1.2526, -0.3285],
         [-0.7988,  0.7175, -0.9701],
         [ 0.2634, -0.9255, -0.3459]]])
>>> pivots
tensor([[ 3,  3,  3],
        [ 3,  3,  3]], dtype=torch.int32)
>>> A_LU, pivots, info = torch.lu(A, get_infos=True)
>>> if info.nonzero().size(0) == 0:
...   print('LU factorization succeeded for all samples!')
LU factorization succeeded for all samples!