Spec-Zone.ru › TensorFlow 2.9

tf.linalg.LinearOperatorFullMatrix

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

LinearOperator представляющий [матрицу(ы)].

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

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

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

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

tf.compat.v1.linalg.LinearOperatorFullMatrix

tf.linalg.LinearOperatorFullMatrix(
    matrix,
    is_non_singular=None,
    is_self_adjoint=None,
    is_positive_definite=None,
    is_square=None,
    name='LinearOperatorFullMatrix'
)

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

# Create a 2 x 2 linear operator.
matrix = [[1., 2.], [3., 4.]]
operator = LinearOperatorFullMatrix(matrix)

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

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

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

operator.shape = [B1,...,Bb] + [M, N],  with b >= 0
x.shape =        [B1,...,Bb] + [N, R],  with R >= 0.

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

LinearOperatorFullMatrix имеет точно такую же производительность, как если бы использовались стандартные TensorFlow матричные операции. Умные решения принимаются на основе следующих подсказок инициализации.

  • Если dtype является действительным, и is_self_adjoint и is_positive_definite, для определителя и решения используется факторизация Холецкого.

Во всех случаях, предположим, что operator — LinearOperatorFullMatrix формы [M, N], и x.shape = [N, R]. Тогда

  • operator.matmul(x) является O(M * N * R).
  • Если M=N, operator.solve(x) является O(N^3 * R).
  • Если M=N, operator.determinant() является O(N^3).

Если вместо этого operator и x имеют форму [B1,...,Bb, M, N] и [B1,...,Bb, N, R], сложность каждой операции увеличивается на B1*...*Bb.

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

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

  • Если is_X == True, вызывающие стороны должны ожидать, что оператор обладает свойством X. Это обещание, которое должно быть выполнено, но не является проверкой во время выполнения. Например, конечная точность плавающей точки может привести к нарушению этих обещаний.
  • Если is_X == False, вызывающие стороны должны ожидать, что оператор не обладает свойством X.
  • Если is_X == None (по умолчанию), вызывающие стороны не должны иметь никаких ожиданий.
Аргументы
matrix Форма [B1,...,Bb, M, N] с b >= 0, M, N >= 0. Разрешенные типы данных: float16, float32, float64, complex64, complex128.
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.
Исключения
TypeError Если diag.dtype не является разрешённым типом.
Атрибуты
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 Размерность Tensor объектов, обрабатываемых этим LinearOperator.
graph_parents Список зависимостей графа этого LinearOperator. (устарело)
Устарело: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Не вызывайте graph_parents.
is_non_singular
is_positive_definite
is_self_adjoint
is_square Возвращает True/False в зависимости от того, является ли этот оператор квадратным.
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(
    x, name='add_to_tensor'
)

Добавить матрицу, представленную этим оператором, к x. Эквивалентно A + x.

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

adjoint

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

adjoint(
    name='adjoint'
)

Возвращает сопряжённое значение текущего 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='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.

Возвращённое 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/LinearOperatorFullMatrix

Spec-Zone.ru

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