Spec-Zone.ru › TensorFlow 2.9

tf.linalg.LinearOperatorScaledIdentity

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

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 (по умолчанию), вызывающие стороны не должны ожидать ничего определенного.
Args
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
Raises
ValueError Если num_rows статически определено, как нескалярное или отрицательное.
Атрибуты
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 Количество DType Tensors, обрабатываемых этим 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 Ранг этого 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.

Args
mat Tensor с той же dtype и формой, совместимой с self.
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'
)

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

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

ConditionNumber < max{100, range_dimension, domain_dimension} * eps,
eps := np.finfo(self.dtype.as_numpy_dtype).eps
Args
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'
)

Возвращает оператор, который проверяет, что этот оператор является самосопряжённым.

Здесь проверяется, что этот оператор точно равен своему эрмитовому транспонированию.

Аргументы
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 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 ложны.

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 ложны.

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
)

© 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/versions/r2.9/api_docs/python/tf/linalg/LinearOperatorScaledIdentity

Spec-Zone.ru

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