Spec-Zone.ru › TensorFlow

tf.linalg.LinearOperatorLowerTriangular

LinearOperator действующий как [пакетный] квадратный нижнетреугольный матрица.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorLowerTriangular

tf.linalg.LinearOperatorLowerTriangular(
    tril,
    is_non_singular=None,
    is_self_adjoint=None,
    is_positive_definite=None,
    is_square=None,
    name='LinearOperatorLowerTriangular'
)

Используется в ноутбуках

Используется в учебниках
  • Заметки к выпуску TFP (блокнот 0.13.0)

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

LinearOperatorLowerTriangular инициализируется с Tensor, имеющей размерность [B1,...,Bb, N, N]. Верхняя треугольная часть последних двух измерений игнорируется.

# Create a 2 x 2 lower-triangular linear operator.
tril = [[1., 2.], [3., 4.]]
operator = LinearOperatorLowerTriangular(tril)

# The upper triangle is ignored.
operator.to_dense()
==> [[1., 0.]
     [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.
tril = tf.random.normal(shape=[2, 3, 4, 4])
operator = LinearOperatorLowerTriangular(tril)

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

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

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

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

Предположим, что operator — это LinearOperatorLowerTriangular формы [N, N], а x.shape = [N, R]. Тогда

  • operator.matmul(x) включает N^2 * R умножений.
  • operator.solve(x) включает N * R размера N обратное подстановки.
  • operator.determinant() включает N размера reduce_prod.

Если вместо этого operator и x имеют форму [B1,...,Bb, N, 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 (по умолчанию), вызывающие стороны не должны ожидать ничего определенного.
Аргументы
tril Форма [B1,...,Bb, N, N] с b >= 0, N >= 0. Нижняя треугольная часть tril определяет этот оператор. Строго верхняя треугольная часть игнорируется.
is_non_singular Ожидать, что этот оператор является невырожденным. Этот оператор является невырожденным тогда и только тогда, когда все его диагональные элементы отличны от нуля.
is_self_adjoint Ожидать, что этот оператор равен своему эрмитовому транспонированию. Этот оператор является самосопряженным только если он диагональный с вещественными диагональными элементами. В этом случае рекомендуется использовать LinearOperatorDiag.
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.
Возможные исключения
ValueError Если is_square является False.
Атрибуты
H Возвращает сопряжённый оператор.

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

batch_shape Форма пакетных измерений этого оператора.

Если этот оператор действует как пакетная матрица 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, в зависимости от того, является ли оператор квадратным.
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.

tril Нижнетреугольная матрица, определяющая этот оператор.

Методы

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

Возвращает присоединённую матрицу текущего 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 Имя для этого 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: str = 'cholesky'
) -> 'LinearOperator'

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

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

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

Число обусловленности

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

cond(
    name='cond'
)

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

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

Определитель

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

determinant(
    name='det'
)

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

Аргументы
name Имя для этого Op.
Возвращаемые значения
Tensor с формой self.batch_shape и тем же dtype, что и self.
Исключения
NotImplementedError Если self.is_square является False.

Часть диагонали

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

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(
    name='domain_dimension_tensor'
)

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

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

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

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

Собственные значения

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

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

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/LinearOperatorLowerTriangular

Spec-Zone.ru

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