Spec-Zone.ru › TensorFlow 2.3

tf.linalg.LinearOperatorFullMatrix

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

LinearOperator матрицы [партч].

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

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

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

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

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 Возвращает сопряжённый оператор к текущему LinearOperator.

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

batch_shape Размерность [партч]-измерений этого LinearOperator

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

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

shape Ранг этого 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.

Методы

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 Имя для созданных операций.
Возвращаемое значение
Утверждение 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'
)

Возвращает объект 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 Питон bool. Если True, умножьте слева на сопряжённое: A^H x.
adjoint_arg Питон 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 Питон 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 Питон bool. Если True, решите систему, включающую сопряжённый оператор: A^H X = rhs.
adjoint_arg Питон 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 рассматривается как [пакетный] вектор, то есть для каждого набора ведущих измерений последнее измерение определяет вектор. Определение совместимости по пакетным измерениям см. в строке документации класса.
adjoint Питон 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'
)

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

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

Spec-Zone.ru

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