Spec-Zone.ru › TensorFlow 2.4

tf.linalg.LinearOperatorLowRankUpdate

Просмотреть исходный код на GitHub

Изменить LinearOperator с помощью обновления ранга K.

Наследуется от: LinearOperator, Module

Псевдонимы

Псевдонимы для миграции

См. Руководство по миграции для получения дополнительной информации.

tf.compat.v1.linalg.LinearOperatorLowRankUpdate

tf.linalg.LinearOperatorLowRankUpdate(
    base_operator, u, diag_update=None, v=None, is_diag_update_positive=None,
    is_non_singular=None, is_self_adjoint=None, is_positive_definite=None,
    is_square=None, name='LinearOperatorLowRankUpdate'
)

Этот оператор действует как [пакетная] матрица A с формой [B1,...,Bb, M, N] для некоторой b >= 0. Первые b индексы индексируют пакетный член. Для каждого пакетного индекса (i1,...,ib), A[i1,...,ib, : :] является M x N матрицей.

LinearOperatorLowRankUpdate представляет собой A = L + U D V^H, где

L, is a LinearOperator representing [batch] M x N matrices
U, is a [batch] M x K matrix.  Typically K << M.
D, is a [batch] K x K matrix.
V, is a [batch] N x K matrix.  Typically K << N.
V^H is the Hermitian transpose (adjoint) of V.

Если M = N, вычисления определителя и обратных матриц выполняются с использованием леммы о определителе матрицы и тождеств Вудри, и поэтому требуют, чтобы L и D были невырожденными.

Попытки вычисления обратных матриц и определителей будут предприниматься, если свойство «is_non_singular» операторов L и D равно False.

В случае, если L и D являются положительно определенными, а U = V, вычисления обратных матриц и определителей могут выполняться с помощью разложения Холецкого.

# Create a 3 x 3 diagonal linear operator.
diag_operator = LinearOperatorDiag(
    diag_update=[1., 2., 3.], is_non_singular=True, is_self_adjoint=True,
    is_positive_definite=True)

# Perturb with a rank 2 perturbation
operator = LinearOperatorLowRankUpdate(
    operator=diag_operator,
    u=[[1., 2.], [-1., 3.], [0., 0.]],
    diag_update=[11., 12.],
    v=[[1., 2.], [-1., 3.], [10., 10.]])

operator.shape
==> [3, 3]

operator.log_abs_determinant()
==> scalar Tensor

x = ... Shape [3, 4] Tensor
operator.matmul(x)
==> Shape [3, 4] Tensor

Совместимость форм

Этот оператор действует на [пакетную] матрицу с совместимой формой. x является пакетной матрицей с совместимой формой для matmul и solve, если

operator.shape = [B1,...,Bb] + [M, N],  with b >= 0
x.shape =        [B1,...,Bb] + [N, R],  with R >= 0.

Производительность

Предположим, operator является LinearOperatorLowRankUpdate формы [M, N], полученной с помощью обновления ранга K оператора base_operator, которое выполняет .matmul(x) над x, имеющим x.shape = [N, R] с O(L_matmul*N*R) сложностью (и аналогично для solve, determinant). Затем, если x.shape = [N, R],

  • operator.matmul(x) является O(L_matmul*N*R + K*N*R)

и если M = N,

  • operator.solve(x) является O(L_matmul*N*R + N*K*R + K^2*R + K^3)
  • operator.determinant() является O(L_determinant + L_solve*N*K + K^2*N + K^3)

Если вместо этого operator и x имеют форму [B1,...,Bb, M, N] и [B1,...,Bb, N, R], каждая операция увеличивается в сложности на B1*...*Bb.

Подсказки свойств матрицы

Этот LinearOperator инициализируется булевыми флагами вида is_X для X = non_singular, self_adjoint, positive_definite, diag_update_positive и square. Эти флаги означают следующее:

  • Если is_X == True, вызывающие стороны должны ожидать, что оператор обладает свойством X. Это обещание, которое должно быть выполнено, но это не проверка во время выполнения. Например, конечная точность с плавающей запятой может привести к нарушению этих обещаний.
  • Если is_X == False, вызывающие стороны должны ожидать, что оператор не обладает свойством X.
  • Если is_X == None (по умолчанию), вызывающие стороны не должны ожидать ничего.
Аргументы
base_operator Форма [B1,...,Bb, M, N].
u Форма [B1,...,Bb, M, K] Tensor той же dtype, что и у base_operator. Это U выше.
diag_update Необязательная форма [B1,...,Bb, K] Tensor с той же dtype, что и у base_operator. Это диагональ D выше. По умолчанию D - это единичный оператор.
v Необязательная Tensor той же dtype, что и у u, и формы [B1,...,Bb, N, K]. По умолчанию v = u, в этом случае возмущение симметрично. Если M != N, то v должно быть установлено, так как возмущение не квадратное.
is_diag_update_positive Python bool. Если True, ожидается diag_update > 0.
is_non_singular Ожидается, что этот оператор является невырожденным. По умолчанию None, если не is_positive_definite автоматически установлен как True (см. ниже).
is_self_adjoint Ожидается, что этот оператор равен своему эрмитовому сопряжению. По умолчанию None, если base_operator является самосопряжённым и v = None (что означает u=v), в этом случае по умолчанию True.
is_positive_definite Ожидается, что этот оператор является положительно определённым. По умолчанию None, если base_operator является положительно определённой v = None (что означает u=v), и is_diag_update_positive, в этом случае по умолчанию True. Отметим, что мы говорим, что оператор является положительно определённым, когда квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x.
is_square Ожидается, что этот оператор действует как квадратные [пакетные] матрицы.
name Имя для этого LinearOperator.
Исключения
ValueError Если флаги is_X установлены несогласованным образом.
Атрибуты
H Возвращает сопряжённый оператор.

Учитывая A, представляющий этот LinearOperator, верните A*. Обратите внимание, что вызов self.adjoint() и self.H эквивалентны.

base_operator Если этот оператор является A = L + U D V^H, это L.
batch_shape Размерность пакетных измерений этого LinearOperator.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то это возвращает TensorShape([B1,...,Bb]), эквивалентное A.shape[:-2]

diag_operator Если этот оператор является A = L + U D V^H, это D.
diag_update Если этот оператор является A = L + U D V^H, это диагональ D.
domain_dimension Размеры (в смысле векторных пространств) области определения этого оператора.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то это возвращает N.

dtype Тип DType операторов, обрабатываемых этим LinearOperator.
graph_parents Список зависимостей графа этого LinearOperator. (устарело)
Предупреждение: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущих версиях. Инструкции по обновлению: Не вызывайте graph_parents.
is_diag_update_positive Если этот оператор является A = L + U D V^H, это подсказка D > 0 поэлементно.
is_non_singular
is_positive_definite
is_self_adjoint
is_square Возвращает True/False в зависимости от того, является ли этот оператор квадратным.
parameters Словарь параметров, используемых для создания этого LinearOperator.
range_dimension Размеры (в смысле векторных пространств) области значений этого оператора.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то это возвращает M.

shape TensorShape этого LinearOperator.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то это возвращает TensorShape([B1,...,Bb, M, N]), эквивалентное A.shape.

tensor_rank Ранг (в смысле тензоров) матрицы, соответствующей этому оператору.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то это возвращает b + 2.

u Если этот оператор является A = L + U D V^H, это U.
v Если этот оператор является A = L + U D V^H, это V.

Методы

add_to_tensor

Просмотреть исходный код

add_to_tensor(
    x, name='add_to_tensor'
)

Добавить матрицу, представленную этим оператором, к x. Эквивалентно A + x.

Аргументы
x Tensor с той же dtype и формой, совместимой с self.shape.
name Имя для этого Op.
Возвращает
Tensor с транслированной формой и той же dtype, что и у self.

adjoint

Просмотреть исходный код

adjoint(
    name='adjoint'
)

Возвращает сопряжённую матрицу текущего LinearOperator.

Учитывая A, представляющую данный LinearOperator, возвращает A*. Обратите внимание, что вызов self.adjoint() и self.H эквивалентны.

Аргументы
name Имя для этого Op.
Возвращаемое значение
LinearOperator, представляющую сопряжённую матрицу этого LinearOperator.

assert_non_singular

Просмотреть исходный код

assert_non_singular(
    name='assert_non_singular'
)

Возвращает утверждение, что этот оператор невырожден.

Этот оператор считается невырожденным, если

ConditionNumber < max{100, range_dimension, domain_dimension} * eps,
eps := np.finfo(self.dtype.as_numpy_dtype).eps
Аргументы
name Имя строки для добавления к создаваемым операциям.
Возвращаемое значение
Утверждение Assert Op, которое при выполнении выдаст исключение InvalidArgumentError, если оператор вырожден.

assert_positive_definite

Просмотреть исходный код

assert_positive_definite(
    name='assert_positive_definite'
)

Возвращает утверждение, что этот оператор положительно определён.

Здесь положительная определённость означает, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что оператор не обязан быть самосопряжённым, чтобы быть положительно определённым.

Аргументы
name Имя для этого Op.
Возвращаемое значение
Утверждение Assert Op, которое при выполнении выдаст исключение InvalidArgumentError, если оператор не является положительно определённым.

assert_self_adjoint

Просмотреть исходный код

assert_self_adjoint(
    name='assert_self_adjoint'
)

Возвращает утверждение, что этот оператор самосопряжён.

Здесь проверяется, что этот оператор точно равен своему эрмитовому транспонированию.

Аргументы
name Имя строки для добавления к создаваемым операциям.
Возвращаемое значение
Утверждение Assert Op, которое при выполнении выдаст исключение InvalidArgumentError, если оператор не является самосопряжённым.

batch_shape_tensor

Просмотреть исходный код

batch_shape_tensor(
    name='batch_shape_tensor'
)

Форма размерностей пакета этого оператора, определяемая во время выполнения.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то это возвращает Tensor, содержащий [B1,...,Bb].

Аргументы
name Имя для этого Op.
Возвращаемое значение
int32 Tensor

cholesky

Просмотреть исходный код

cholesky(
    name='cholesky'
)

Возвращает фактор Холецкого как LinearOperator.

Учитывая A, представляющую этот LinearOperator, если A является положительно определённой самосопряжённой матрицей, возвращает L, где A = L L^T, т.е. факторизация Холецкого.

Args
name Имя для этого Op.
Returns
LinearOperator, представляющая нижнетреугольную матрицу в разложении Холецкого.
Raises
ValueError Если LinearOperator не предполагается положительно определённой и самосопряжённой.

Условное число

Просмотреть исходный код

cond(
    name='cond'
)

Возвращает условное число этого линейного оператора.

Args
name Имя для этого Op.
Returns
Форма [B1,...,Bb] Tensor той же dtype, что и у self.

Определитель

Просмотреть исходный код

determinant(
    name='det'
)

Определитель для каждого члена пакета.

Args
name Имя для этого Op.
Returns
Tensor с формой self.batch_shape и той же dtype, что и у self.
Raises
NotImplementedError Если self.is_square является False.

Часть диагонали

Просмотреть исходный код

diag_part(
    name='diag_part'
)

Эффективное получение [пакетной] диагональной части этого оператора.

Если у этого оператора форма [B1,...,Bb, M, N], это возвращает Tensor diagonal, формы [B1,...,Bb, min(M, N)], где diagonal[b1,...,bb, i] = self.to_dense()[b1,...,bb, i, i].

my_operator = LinearOperatorDiag([1., 2.])

# Efficiently get the diagonal
my_operator.diag_part()
==> [1., 2.]

# Equivalent, but inefficient method
tf.linalg.diag_part(my_operator.to_dense())
==> [1., 2.]
Args
name Имя для этого Op.
Returns
diag_part Tensor с той же dtype, что и self.

Размерность области

Просмотреть исходный код

domain_dimension_tensor(
    name='domain_dimension_tensor'
)

Размерность (в смысле векторных пространств) области действия этого оператора.

Определяется во время выполнения.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то он возвращает N.

Args
name Имя для этого Op.
Returns
int32 Tensor

Собственные значения

Просмотреть исходный код

eigvals(
    name='eigvals'
)

Возвращает собственные значения этого линейного оператора.

Если оператор отмечен как самосопряжённый (через is_self_adjoint), это вычисление может быть более эффективным.

Примечание: В настоящее время это поддерживает только самосопряжённые операторы.
Args
name Имя для этого Op.
Returns
Форма [B1,...,Bb, N] Tensor с той же dtype, что и у self.

Обратный

Просмотр исходного кода

inverse(
    name='inverse'
)

Возвращает обратную матрицу этого LinearOperator.

Учитывая A, представляющее этот LinearOperator, вернуть LinearOperator, представляющий A^-1.

Аргументы
name Область именования операций, которую нужно использовать для операций, добавленных этим методом.
Возвращаемое значение
LinearOperator, представляющий обратную матрицу.
Исключения
ValueError Если LinearOperator не указано, что является non_singular.

log_abs_determinant

Просмотр исходного кода

log_abs_determinant(
    name='log_abs_det'
)

Логарифм абсолютного значения определителя для каждого члена пакетных данных.

Аргументы
name Имя для этого Op.
Возвращаемое значение
Tensor со формой self.batch_shape и тем же dtype, что и self.
Исключения
NotImplementedError Если self.is_square является False.

matmul

Просмотр исходного кода

matmul(
    x, adjoint=False, adjoint_arg=False, name='matmul'
)

Преобразование [пакетной] матрицы x с левым умножением: x --> Ax.

# Make an operator acting like batch matrix A.  Assume A.shape = [..., M, N]
operator = LinearOperator(...)
operator.shape = [..., M, N]

X = ... # shape [..., N, R], batch matrix, R > 0.

Y = operator.matmul(X)
Y.shape
==> [..., M, R]

Y[..., :, r] = sum_j A[..., :, j] X[j, r]
Аргументы
x LinearOperator или Tensor с совместимой формой и тем же dtype, что и self. См. строку документации класса для определения совместимости.
adjoint Python bool. Если True, умножить слева на сопряженную матрицу: A^H x.
adjoint_arg Python bool. Если True, вычислить A x^H, где x^H — это эрмитово сопряжение (транспонирование и комплексное сопряжение).
name Имя для этого Op.
Возвращаемое значение
LinearOperator или Tensor со формой [..., M, R] и тем же dtype, что и self.

matvec

Просмотр исходного кода

matvec(
    x, adjoint=False, name='matvec'
)

Преобразование [пакетного] вектора x с левым умножением: x --> Ax.

# Make an operator acting like batch matrix A.  Assume A.shape = [..., M, N]
operator = LinearOperator(...)

X = ... # shape [..., N], batch vector

Y = operator.matvec(X)
Y.shape
==> [..., M]

Y[..., :] = sum_j A[..., :, j] X[..., j]
Аргументы
x Tensor с совместимой формой и тем же dtype, что и self. x рассматривается как [пакетный] вектор, что означает, что для каждого набора ведущих измерений последнее измерение определяет вектор. См. строку документации класса для определения совместимости.
adjoint Python bool. Если True, умножить слева на сопряженную матрицу: A^H x.
name Имя для этого Op.
Возвращаемое значение
Tensor с формой [..., M] и тем же dtype, что и self.

range_dimension_tensor

Просмотр исходного кода

range_dimension_tensor(
    name='range_dimension_tensor'
)

Размерность (в смысле векторных пространств) области действия этого оператора.

Определяется во время выполнения.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то возвращается M.

Аргументы
name Имя для этого Op.
Возвращаемое значение
int32 Tensor

shape_tensor

Просмотр исходного кода

shape_tensor(
    name='shape_tensor'
)

Форма этого LinearOperator, определённая во время выполнения.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то он возвращает Tensor, содержащую [B1,...,Bb, M, N], эквивалентную tf.shape(A).

Аргументы
name Имя для этого Op.
Возвращаемое значение
int32 Tensor

solve

Просмотр исходного кода

solve(
    rhs, adjoint=False, adjoint_arg=False, name='solve'
)

Решение (точное или приближённое) R (пакетных) систем уравнений: A X = rhs.

Возвращённое Tensor будет близко к точному решению, если A хорошо обусловлено. В противном случае близость будет варьироваться. Подробности см. в строке документации класса.

Примеры:

# Make an operator acting like batch matrix A.  Assume A.shape = [..., M, N]
operator = LinearOperator(...)
operator.shape = [..., M, N]

# Solve R > 0 linear systems for every member of the batch.
RHS = ... # shape [..., M, R]

X = operator.solve(RHS)
# X[..., :, r] is the solution to the r'th linear system
# sum_j A[..., :, j] X[..., j, r] = RHS[..., :, r]

operator.matmul(X)
==> RHS
Аргументы
rhs Tensor с той же dtype, что и этот оператор, и совместимой формой. rhs обрабатывается как [пакетная] матрица, что означает, что для каждого набора ведущих измерений последние два измерения определяют матрицу. См. строку документации класса для определения совместимости.
adjoint Python bool. Если True, решить систему, включающую сопряжённый оператор этого LinearOperator: A^H X = rhs.
adjoint_arg Python bool. Если True, решить A X = rhs^H, где rhs^H — это эрмитово сопряжение (транспонирование и комплексное сопряжение).
name Область именования операций, которую нужно использовать для операций, добавленных этим методом.
Возвращаемое значение
Tensor с формой [...,N, R] и тем же dtype, что и rhs.
Исключения
NotImplementedError Если self.is_non_singular или is_square равно False.

solvevec

Просмотр исходного кода

solvevec(
    rhs, adjoint=False, name='solve'
)

Решение одного уравнения с наилучшими усилиями: A X = rhs.

Возвращённое Tensor будет близко к точному решению, если A хорошо обусловлено. В противном случае близость будет варьироваться. Подробности см. в строке документации класса.

Примеры:

# Make an operator acting like batch matrix A.  Assume A.shape = [..., M, N]
operator = LinearOperator(...)
operator.shape = [..., M, N]

# Solve one linear system for every member of the batch.
RHS = ... # shape [..., M]

X = operator.solvevec(RHS)
# X is the solution to the linear system
# sum_j A[..., :, j] X[..., j] = RHS[..., :]

operator.matvec(X)
==> RHS
Аргументы
rhs Tensor с той же dtype, что и этот оператор. rhs обрабатывается как [пакетный] вектор, что означает, что для каждого набора ведущих измерений последнее измерение определяет вектор. См. строку документации класса для определения совместимости относительно пакетных измерений.
adjoint Python bool. Если True, решить систему, включающую сопряжённый оператор этого LinearOperator: A^H X = rhs.
name Область именования операций, которую нужно использовать для операций, добавленных этим методом.
Возвращаемое значение
Tensor с формой [...,N] и тем же dtype, что и rhs.
Исключения
NotImplementedError Если self.is_non_singular или is_square равно False.

tensor_rank_tensor

Просмотреть исходный код

tensor_rank_tensor(
    name='tensor_rank_tensor'
)

Ранг (в смысле тензоров) матрицы, соответствующей этому оператору.

Если этот оператор действует как матрица A с A.shape = [B1,...,Bb, M, N], то возвращается b + 2.

Аргументы
name Название для этого Op.
Возвращаемое значение
int32 Tensor, определённое во время выполнения.

to_dense

Просмотреть исходный код

to_dense(
    name='to_dense'
)

Возвращает плотно заполненную (пакетную) матрицу, представляющую этот оператор.

trace

Просмотреть исходный код

trace(
    name='trace'
)

След линейного оператора, равный сумме self.diag_part().

Если оператор квадратный, это также сумма собственных значений.

Аргументы
name Название для этого Op.
Возвращаемое значение
Форма [B1,...,Bb] Tensor того же dtype, что и self.

__matmul__

Просмотреть исходный код

__matmul__(
    other
)

© 2020 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.4/api_docs/python/tf/linalg/LinearOperatorLowRankUpdate

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API