Spec-Zone.ru › TensorFlow

tf.linalg.LinearOperatorScaledIdentity

LinearOperator, действующий как масштабированная единичная [пакетная] матрица A = c I.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorScaledIdentity

tf.linalg.LinearOperatorScaledIdentity(
    num_rows,
    multiplier,
    is_non_singular=None,
    is_self_adjoint=None,
    is_positive_definite=None,
    is_square=True,
    assert_proper_shapes=False,
    name='LinearOperatorScaledIdentity'
)

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

LinearOperatorIdentity инициализируется с помощью num_rows и multiplier (Tensor) формы [B1,...,Bb]. N задается равным num_rows, а multiplier определяет масштаб для каждого элемента пакета.

# Create a 2 x 2 scaled identity matrix.
operator = LinearOperatorIdentity(num_rows=2, multiplier=3.)

operator.to_dense()
==> [[3., 0.]
     [0., 3.]]

operator.shape
==> [2, 2]

operator.log_abs_determinant()
==> 2 * Log[3]

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

y = tf.random.normal(shape=[3, 2, 4])
# Note that y.shape is compatible with operator.shape because operator.shape
# is broadcast to [3, 2, 2].
x = operator.solve(y)
==> 3 * x

# Create a 2-batch of 2x2 identity matrices
operator = LinearOperatorIdentity(num_rows=2, multiplier=5.)
operator.to_dense()
==> [[[5., 0.]
      [0., 5.]],
     [[5., 0.]
      [0., 5.]]]

x = ... Shape [2, 2, 3]
operator.matmul(x)
==> 5 * x

# Here the operator and x have different batch_shape, and are broadcast.
x = ... Shape [1, 2, 3]
operator.matmul(x)
==> 5 * x

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

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

operator.shape = [B1,...,Bb] + [N, N],  with b >= 0
x.shape =   [C1,...,Cc] + [N, R],
and [C1,...,Cc] broadcasts with [B1,...,Bb] to [D1,...,Dd]

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

  • operator.matmul(x) — O(D1*...*Dd*N*R)
  • operator.solve(x) — O(D1*...*Dd*N*R)
  • operator.determinant() — O(D1*...*Dd)

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

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

  • Если is_X == True, вызывающие код должны рассчитывать на то, что оператор обладает свойством X. Это обещание, которое должно выполняться, но оно не является проверкой во время выполнения. Например, конечная точность чисел с плавающей точкой может привести к нарушению этих обещаний.
  • Если is_X == False, вызывающие код должны рассчитывать на то, что оператор не обладает свойством X.
  • Если is_X == None (значение по умолчанию), вызывающий код не должен иметь никаких ожиданий в ту или иную сторону.
Аргументы
num_rows Неотрицательное скалярное целое число Tensor. Число строк в соответствующей единичной матрице.
multiplier Tensor формы [B1,...,Bb] или [] (скаляр).
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 Предполагается, что этот оператор действует как квадратные [пакетные] матрицы.
assert_proper_shapes Python bool. Если False, выполнять только статические проверки корректности форм аргументов инициализации и методов. Если True, а статические проверки не дают однозначного результата, добавлять проверки в граф.
name Имя этого LinearOperator
Вызывает исключения
ValueError Если статически установлено, что num_rows не является скаляром или является отрицательным.
Атрибуты
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 в зависимости от того, является ли оператор квадратным.
multiplier [Пакетное] скалярное значение Tensor, c в cI.
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(
    mat, name='add_to_tensor'
)

Прибавляет матрицу, представленную этим оператором, к mat. Эквивалентно I + mat.

Аргументы
mat Tensor с тем же dtype и формой, допускающей broadcasting к self.
name Имя для этого Op.
Возвращает
Tensor с формой, полученной в результате broadcasting, и тем же 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, что и у 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: 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 Python bool. Если True, решить систему с сопряжённым оператором этого LinearOperator: 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 имеет значение 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 bool. Если 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/LinearOperatorScaledIdentity

Spec-Zone.ru

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