Spec-Zone.ru › TensorFlow

tf.linalg.LinearOperatorKronecker

Произведение Кронекера между двумя LinearOperators.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorKronecker

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

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

Если opj имеет форму batch_shape_j + [M_j, N_j], то составной оператор будет иметь форму, равную broadcast_batch_shape + [prod M_j, prod N_j], где произведение берётся по всем операторам.

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

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

operator.shape
==> [4, 4]

operator.log_abs_determinant()
==> scalar Tensor

x = ... Shape [4, 2] Tensor
operator.matmul(x)
==> Shape [4, 2] 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 20 x 30 operators.
operator_large = LinearOperatorKronecker([operator_45, operator_56])

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

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

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

Рекомендации по свойствам матриц

Этот 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. По умолчанию - имена отдельных операторов, соединённые _x_.
Возможные ошибки
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, обрабатываемых этим 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'
)

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

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

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 Имя для данного оператора.
Возвращает
Объект 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 Имя для данного оператора.
Возвращает
int32 Tensor

cholesky

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

cholesky(
    name: str = 'cholesky'
) -> 'LinearOperator'

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

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

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

cond

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

cond(
    name='cond'
)

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

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

determinant

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

determinant(
    name='det'
)

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

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

domain_dimension_tensor

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

domain_dimension_tensor(
    name='domain_dimension_tensor'
)

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

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

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

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

eigvals

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

eigvals(
    name='eigvals'
)

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

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

Примечание: В настоящее время поддерживаются только самосопряжённые операторы.
Аргументы
name Имя для данного оператора.
Возвращает
Форма [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-выражение. Если True, умножить слева на сопряжённое: A^H x.
adjoint_arg Python-выражение. Если 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-выражение. Если 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-выражение. Если True, решить систему, вовлекая сопряжённый этому оператору: A^H X = rhs.
adjoint_arg 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 Python-выражение. Если True, решить систему, вовлекая сопряжённый этому оператору: 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/LinearOperatorKronecker

Spec-Zone.ru

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