Spec-Zone.ru › TensorFlow 2.4

tf.linalg.LinearOperatorFullMatrix

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

LinearOperator представляет собой [пакет] матрицу.

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

Просмотр псевдонимов

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

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

tf.compat.v1.linalg.LinearOperatorFullMatrix

tf.linalg.LinearOperatorFullMatrix(
    matrix, is_non_singular=None, is_self_adjoint=None, is_positive_definite=None,
    is_square=None, name='LinearOperatorFullMatrix'
)

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

# Create a 2 x 2 linear operator.
matrix = [[1., 2.], [3., 4.]]
operator = LinearOperatorFullMatrix(matrix)

operator.to_dense()
==> [[1., 2.]
     [3., 4.]]

operator.shape
==> [2, 2]

operator.log_abs_determinant()
==> scalar Tensor

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

# Create a [2, 3] batch of 4 x 4 linear operators.
matrix = tf.random.normal(shape=[2, 3, 4, 4])
operator = LinearOperatorFullMatrix(matrix)

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

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

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

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

LinearOperatorFullMatrix имеет точно такую же производительность, как и использование стандартных операций TensorFlow матриц. Используются разумные решения на основе следующих подсказок инициализации.

  • Если dtype является вещественным, и is_self_adjoint и is_positive_definite, для вычисления определителя и решения используется факторизация Холецкого.

Во всех случаях, предположим, что operator является LinearOperatorFullMatrix с формой [M, N], и x.shape = [N, R]. Тогда

  • operator.matmul(x) является O(M * N * R).
  • Если M=N, operator.solve(x) является O(N^3 * R).
  • Если M=N, operator.determinant() является O(N^3).

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

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

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

  • Если is_X == True, вызывающие стороны должны ожидать, что оператор обладает свойством X. Это обещание, которое должно быть выполнено, но это не проверка во время выполнения. Например, конечная точность плавающей точки может привести к нарушению этих обещаний.
  • Если is_X == False, вызывающие стороны должны ожидать, что оператор не обладает X.
  • Если is_X == None (по умолчанию), вызывающие стороны не должны иметь ожиданий.
Аргументы
matrix Форма [B1,...,Bb, M, N] с b >= 0, M, N >= 0. Разрешённые типы данных: float16, float32, float64, complex64, complex128.
is_non_singular Ожидается, что этот оператор является невырожденным.
is_self_adjoint Ожидается, что этот оператор равен своему эрмитовому транспонированию.
is_positive_definite Ожидается, что этот оператор является положительно определённым, то есть квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что мы не требуем, чтобы оператор был самосопряжённым, чтобы быть положительно определённым. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix#Extension_for_non-symmetric_matrices
is_square Ожидается, что этот оператор действует как квадратные [пакетные] матрицы.
name Имя для этого LinearOperator.
Исключения
TypeError Если diag.dtype не является разрешённым типом.
Атрибуты
H Возвращает сопряжённый оператор.

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

batch_shape Размерность пакетных измерений этого оператора.

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

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

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

dtype Размеры Tensor объектов, обрабатываемых этим оператором.
graph_parents Список зависимостей графа этого оператора. (устарело)
Предупреждение: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: не вызывайте graph_parents.
is_non_singular
is_positive_definite
is_self_adjoint
is_square Возвращает True/False в зависимости от того, является ли оператор квадратным.
parameters Словарь параметров, используемых для создания этого оператора.
range_dimension Размерность (в смысле векторных пространств) области значений этого оператора.

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

shape Ранг этого оператора.

Если этот оператор действует как пакетная матрица 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.

Методы

add_to_tensor

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

add_to_tensor(
    x, name='add_to_tensor'
)

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

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

adjoint

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

adjoint(
    name='adjoint'
)

Возвращает сопряжённый оператор.

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

Аргументы
name Имя для этого Op.
Возвращает
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_positive_definite

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

assert_positive_definite(
    name='assert_positive_definite'
)

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

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

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

assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

Возвращает объект Op, который проверяет, что этот оператор является самосопряжённым.

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

Аргументы
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, т.е. разложение Холецкого.

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

cond

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

cond(
    name='cond'
)

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

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

determinant

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

determinant(
    name='det'
)

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

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

diag_part

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

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.]
Аргументы
name Имя для этой Op.
Возвращает
diag_part Tensor с той же dtype что и self.

domain_dimension_tensor

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

domain_dimension_tensor(
    name='domain_dimension_tensor'
)

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

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

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

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

eigvals

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

eigvals(
    name='eigvals'
)

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

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

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

inverse

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

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'
)

Преобразование вектора [batch] 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 рассматривается как [batch] вектор, то есть для каждой набора старших измерений последнее измерение определяет вектор. Определение совместимости см. в документации класса.
adjoint Python bool. Если True, выполните левое умножение на сопряжённую матрицу: A^H x.
name Имя для этого Op.
Возвращаемое значение
Tensor с формой [..., M] и тем же dtype что и self.

range_dimension_tensor

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

range_dimension_tensor(
    name='range_dimension_tensor'
)

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

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

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

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

shape_tensor

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

shape_tensor(
    name='shape_tensor'
)

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

Если этот оператор действует как матрица [batch] 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'
)

Решение (точное или приближённое) системы (batch) уравнений 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 рассматривается как [batch] матрица, то есть для каждой набора старших измерений последние два измерения определяют матрицу. Определение совместимости см. в документации класса.
adjoint Python bool. Если True, решайте систему, включающую сопряжённый оператор: 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 ложно.

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 рассматривается как [batch] вектор, то есть для каждой набора старших измерений последнее измерение определяет вектор. Определение совместимости по пакетным измерениям см. в документации класса.
adjoint Python bool. Если True, решайте систему, включающую сопряжённый оператор: A^H X = rhs.
name Диапазон имён для операций, добавленных этим методом.
Возвращаемое значение
Tensor с формой [...,N] и тем же dtype что и rhs.
Исключения
NotImplementedError Если self.is_non_singular или is_square ложно.

tensor_rank_tensor

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

tensor_rank_tensor(
    name='tensor_rank_tensor'
)

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

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

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

to_dense

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

to_dense(
    name='to_dense'
)

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

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/LinearOperatorFullMatrix

Spec-Zone.ru

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