Spec-Zone.ru › TensorFlow

tf.linalg.LinearOperatorComposition

Составляет композицию из одного или нескольких LinearOperators.

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

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

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

Подробнее см. в руководстве по миграции.

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 действует как [пакетная] матрица Aj, то op_composed действует как [пакетная] матрица, полученная умножением 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 (значение по умолчанию), у вызывающего кода не должно быть ожиданий ни в ту, ни в другую сторону.
Аргументы
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 Ожидается, что этот оператор действует как квадратные [пакетные] матрицы.
name Имя этого LinearOperator. По умолчанию используются имена отдельных операторов, соединённые с помощью _o_.
Вызывает исключения
TypeError Если все операторы имеют разные dtype.
ValueError Если operators пуст.
Атрибуты
H Возвращает сопряжённый оператор для текущего LinearOperator.

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

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

Методы

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: str = 'adjoint'
) -> 'LinearOperator'

Возвращает сопряжённый оператор для текущего LinearOperator.

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

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

assert_non_singular

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

assert_non_singular(
    name='assert_non_singular'
)

Возвращает Op, проверяющий, что этот оператор невырожденный.

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

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

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

Здесь под положительной определённостью понимается, что квадратичная форма 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: str = 'cholesky'
) -> 'LinearOperator'

Возвращает разложение Холецкого в виде 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, что и у текущего объекта.

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: str = 'inverse'
) -> 'LinearOperator'

Возвращает обратный оператор для этого 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 bool Python. Если True, решить систему с использованием сопряжённого оператора этого LinearOperator: A^H X = rhs.
adjoint_arg bool Python. Если 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 bool Python. Если 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.

__getitem__

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

__getitem__(
    slices
)

__matmul__

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

__matmul__(
    other
)

© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/api_docs/python/tf/linalg/LinearOperatorComposition

Spec-Zone.ru

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