Spec-Zone.ru › TensorFlow 2.9

tf.linalg.LinearOperatorZeros

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

LinearOperator как [пакетная] нулевая матрица.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorZeros

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

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

LinearOperatorZeros инициализируется с помощью num_rows, и необязательно num_columns,batch_shape, anddtypearguments. Ifnum_columnsisNone, then this operator will be initialized as a square matrix. Ifbatch_shapeisNone, this operator efficiently passes through all arguments. Ifbatch_shape` предоставляется, может произойти вещание, что потребует создания копий.

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

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

operator.shape
==> [2, 2]

operator.determinant()
==> 0.

x = ... Shape [2, 4] Tensor
operator.matmul(x)
==> Shape [2, 4] Tensor, same as x.

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

# 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 tf.zeros_like(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 tf.zeros_like([x, x])

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

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

operator.shape = [B1,...,Bb] + [N, M],  with b >= 0
x.shape =   [C1,...,Cc] + [M, R],
and [C1,...,Cc] broadcasts with [B1,...,Bb] to [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. Количество строк в соответствующей нулевой матрице.
num_columns Скалярное неотрицательное целое число Tensor. Количество столбцов в соответствующей нулевой матрице. Если None, по умолчанию используется значение num_rows.
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 Если num_columns статически определено как нескалярное или отрицательное.
ValueError Если batch_shape статически определено как не 1-мерное или отрицательное.
ValueError Если любой из следующих элементов не True: {is_self_adjoint, is_non_singular, is_positive_definite}.
Атрибуты
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 в зависимости от того, является ли этот оператор квадратным.
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.

Аргументы
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'
)

Возвращает 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 Имя области видимости для операций, добавленных этим методом.
Возвращаемое значение
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, решить систему, включающую сопряжённый оператор: 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, решить систему, включающую сопряжённый оператор: 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.

__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/LinearOperatorZeros

Spec-Zone.ru

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