Spec-Zone.ru › TensorFlow 1.15

tf.linalg.LinearOperatorIdentity

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

LinearOperator действуя как [пакетная] квадратная единичная матрица.

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

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

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

tf.compat.v1.linalg.LinearOperatorIdentity, `tf.compat.v2.linalg.LinearOperatorIdentity`

tf.linalg.LinearOperatorIdentity(
    num_rows, batch_shape=None, dtype=None, is_non_singular=True,
    is_self_adjoint=True, is_positive_definite=True, is_square=True,
    assert_proper_shapes=False, name='LinearOperatorIdentity'
)

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

LinearOperatorIdentity инициализируется с num_rows, и необязательно batch_shape, и dtype аргументами. Если batch_shape — None, этот оператор эффективно пропускает все аргументы. Если batch_shape предоставлено, может произойти вещание, что потребует создания копий.

# Create a 2 x 2 identity matrix.
operator = LinearOperatorIdentity(num_rows=2, dtype=tf.float32)

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

operator.shape
==> [2, 2]

operator.log_abs_determinant()
==> 0.

x = ... Shape [2, 4] Tensor
operator.matmul(x)
==> Shape [2, 4] Tensor, same as 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].
# This broadcast does NOT require copying data, since we can infer that y
# will be passed through without changing shape.  We are always able to infer
# this if the operator has no batch_shape.
x = operator.solve(y)
==> Shape [3, 2, 4] Tensor, same as y.

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

# Here, even though the operator has a batch shape, the input is the same as
# the output, so x can be passed through without a copy.  The operator is able
# to detect that no broadcast is necessary because both x and the operator
# have statically defined shape.
x = ... Shape [2, 2, 3]
operator.matmul(x)
==> Shape [2, 2, 3] Tensor, same as x

# Here the operator and x have different batch_shape, and are broadcast.
# This requires a copy, since the output is different size than the input.
x = ... Shape [1, 2, 3]
operator.matmul(x)
==> Shape [2, 2, 3] Tensor, equal to [x, 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]

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

Если batch_shape аргумент инициализации — None:

  • operator.matmul(x) — O(1)
  • operator.solve(x) — O(1)
  • operator.determinant() — O(1)

Если batch_shape аргумент инициализации указан, и статические проверки не могут исключить необходимость вещания:

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

Указания на свойства матрицы

Этот 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. Количество строк в соответствующей единичной матрице.
batch_shape Необязательное 1-D целое число Tensor. Форма ведущих измерений. Если None, этот оператор не имеет ведущих измерений.
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 Ожидать, что этот оператор действует как квадратные [пакетные] матрицы.
assert_proper_shapes Python bool. Если False, выполняйте только статические проверки, чтобы убедиться, что аргументы инициализации и метода имеют правильную форму. Если True, а статические проверки не позволяют сделать вывод, добавьте проверки в граф.
name Имя этого LinearOperator
Исключения
ValueError Если num_rows статически определено как нескалярное или отрицательное.
ValueError Если batch_shape статически определено как не одномерное или отрицательное.
ValueError Если любой из следующих элементов не True: {is_self_adjoint, is_non_singular, is_positive_definite}.
TypeError Если num_rows или batch_shape имеют тип ссылки (например, Variable).
Атрибуты
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 Размерность Tensors, обрабатываемых этим LinearOperator
graph_parents Список зависимостей графа этого LinearOperator
is_non_singular
is_positive_definite
is_self_adjoint
is_square Вернуть True/False в зависимости от того, является ли этот оператор квадратным.
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.

Аргументы
mat Tensor с той же dtype и формой, вещаемой к self.
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'
)

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

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

ConditionNumber < max{100, range_dimension, domain_dimension} * eps,
eps := np.finfo(self.dtype.as_numpy_dtype).eps
Аргументы
name Строковое имя для добавления к созданным операциям.
END_OF_DOCUMENT_MARKER
Возвращаемое значение
Объект 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='cholesky'
)

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

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

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

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

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 Питон bool. Если True, умножить слева на сопряжённое: A^H x.
adjoint_arg Питон 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 matric 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 Питон 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 Питон bool. Если True, решить систему, связанную с сопряжённым оператором: A^H X = rhs.
adjoint_arg Питон 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 Питон bool. Если True, решить систему, связанную с сопряжённым оператором: 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.

© 2020 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/linalg/LinearOperatorIdentity

Spec-Zone.ru

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