Spec-Zone.ru › TensorFlow 2.3

tf.linalg.LinearOperatorComposition

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

Компонует один или несколько LinearOperators.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorComposition

tf.linalg.LinearOperatorComposition(
    operators, is_non_singular=None, is_self_adjoint=None,
    is_positive_definite=None, is_square=None, name=None
)

Этот оператор компонует один или несколько линейных операторов [op1,...,opJ], создавая новый LinearOperator с действием, определённым следующим образом:

op_composed(x) := op1(op2(...(opJ(x)...))

Если opj действует как [batch] матрица Aj, то op_composed действует как [batch] матрица, полученная в результате умножения A1 A2...AJ.

Если у opj форма batch_shape_j + [M_j, N_j], то должно выполняться условие N_j = M_{j+1}, в этом случае составной оператор имеет форму, равную broadcast_batch_shape + [M_1, N_J], где broadcast_batch_shape является взаимным распространением batch_shape_j, j = 1,...,J, предполагая, что промежуточные формы пакетных размеров распространяются. Даже если составная форма определена корректно, методы составного оператора могут завершиться ошибкой из-за отсутствия возможности распространения в методах определяющих операторов.

# Create a 2 x 2 linear operator composed of two 2 x 2 operators.
operator_1 = LinearOperatorFullMatrix([[1., 2.], [3., 4.]])
operator_2 = LinearOperatorFullMatrix([[1., 0.], [0., 1.]])
operator = LinearOperatorComposition([operator_1, operator_2])

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 5 linear operators.
matrix_45 = tf.random.normal(shape=[2, 3, 4, 5])
operator_45 = LinearOperatorFullMatrix(matrix)

# Create a [2, 3] batch of 5 x 6 linear operators.
matrix_56 = tf.random.normal(shape=[2, 3, 5, 6])
operator_56 = LinearOperatorFullMatrix(matrix_56)

# Compose to create a [2, 3] batch of 4 x 6 operators.
operator_46 = LinearOperatorComposition([operator_45, operator_56])

# Create a shape [2, 3, 6, 2] vector.
x = tf.random.normal(shape=[2, 3, 6, 2])
operator.matmul(x)
==> Shape [2, 3, 4, 2] Tensor

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

Производительность LinearOperatorComposition при любом операторе равна сумме производительностей отдельных операторов.

Свойства матрицы

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

  • Если is_X == True, вызывающие стороны должны ожидать, что оператор обладает свойством X. Это обещание, которое должно быть выполнено, но это не утверждение во время выполнения. Например, конечная точность плавающей точки может привести к нарушению этих обещаний.
  • Если is_X == False, вызывающие стороны должны ожидать, что оператор не обладает свойством X.
  • Если is_X == None (по умолчанию), вызывающие стороны не должны иметь ожиданий относительно этого.
Args
operators Итерируемый список объектов LinearOperator, каждый с той же dtype и формой, совместимой для композиции.
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 Ожидается, что этот оператор действует как квадратные [batch] матрицы.
name Имя для этого LinearOperator. По умолчанию - имена отдельных операторов, соединённые с _o_.
Raises
TypeError Если все операторы не имеют одинаковой dtype.
ValueError Если operators пусто.
Атрибуты
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 Размерность пакетных измерений, обрабатываемых этим LinearOperator.
graph_parents Список зависимостей графа этого LinearOperator. (устарело)
Предупреждение: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Не вызывайте graph_parents.
is_non_singular
is_positive_definite
is_self_adjoint
is_square Возвращает True/False в зависимости от того, является ли этот оператор квадратным.
operators
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.

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

adjoint

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

adjoint(
    name='adjoint'
)

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

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

Args
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
Args
name Строковое имя для добавления к созданным операциям.
Возвращает
Утверждение Op, которое, при выполнении, поднимет исключение InvalidArgumentError, если оператор вырожден.

assert_positive_definite

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

assert_positive_definite(
    name='assert_positive_definite'
)

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

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

Args
name Имя для этого Op.
Возвращает
Утверждение 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 Область именования ops, используемая этим методом.
Возвращаемое значение
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.

Возвращаемое значение будет близко к точному решению, если 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, решить систему, включающую сопряжённый оператор: 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.

Возвращаемое значение будет близко к точному решению, если 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, решить систему, включающую сопряжённый оператор: 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/LinearOperatorComposition

Spec-Zone.ru

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