Spec-Zone.ru › TensorFlow 1.15

tf.contrib.distributions.MultivariateNormalDiag

Многомерное нормальное распределение на R^k.

tf.contrib.distributions.MultivariateNormalDiag(
    loc=None, scale_diag=None, scale_identity_multiplier=None, validate_args=False,
    allow_nan_stats=True, name='MultivariateNormalDiag'
)

Распределение многомерной нормальной случайной величины определено на R^k и параметризовано (пачкой) вектором длины k loc (также известным как "mu") и (пачкой) k x k scale матрицей; covariance = scale @ scale.T где @ обозначает матричное умножение.

Математические подробности

Функция плотности вероятности (pdf) равна,

pdf(x; loc, scale) = exp(-0.5 ||y||**2) / Z,
y = inv(scale) @ (x - loc),
Z = (2 pi)**(0.5 k) |det(scale)|,

где:

  • loc — вектор в R^k,
  • scale — линейный оператор в R^{k x k}, cov = scale @ scale.T,
  • Z обозначает константу нормировки, и,
  • ||y||**2 обозначает квадратную евклидову норму y.

Матрица (без пакета) scale имеет вид:

scale = diag(scale_diag + scale_identity_multiplier * ones(k))

где:

  • scale_diag.shape = [k], и,
  • scale_identity_multiplier.shape = [].

Дополнительные ведущие размеры (если таковые имеются) будут индексировать пакеты.

Если и scale_diag, и scale_identity_multiplier являются None, то scale — это единичная матрица.

Распределение MultivariateNormal является членом семейства масштабных параметров, т.е. его можно построить как,

X ~ MultivariateNormal(loc=0, scale=1)   # Identity scale, zero shift.
Y = scale @ X + loc

Примеры

import tensorflow_probability as tfp
tfd = tfp.distributions

# Initialize a single 2-variate Gaussian.
mvn = tfd.MultivariateNormalDiag(
    loc=[1., -1],
    scale_diag=[1, 2.])

mvn.mean().eval()
# ==> [1., -1]

mvn.stddev().eval()
# ==> [1., 2]

# Evaluate this on an observation in `R^2`, returning a scalar.
mvn.prob([-1., 0]).eval()  # shape: []

# Initialize a 3-batch, 2-variate scaled-identity Gaussian.
mvn = tfd.MultivariateNormalDiag(
    loc=[1., -1],
    scale_identity_multiplier=[1, 2., 3])

mvn.mean().eval()  # shape: [3, 2]
# ==> [[1., -1]
#      [1, -1],
#      [1, -1]]

mvn.stddev().eval()  # shape: [3, 2]
# ==> [[1., 1],
#      [2, 2],
#      [3, 3]]

# Evaluate this on an observation in `R^2`, returning a length-3 vector.
mvn.prob([-1., 0]).eval()  # shape: [3]

# Initialize a 2-batch of 3-variate Gaussians.
mvn = tfd.MultivariateNormalDiag(
    loc=[[1., 2, 3],
         [11, 22, 33]]           # shape: [2, 3]
    scale_diag=[[1., 2, 3],
                [0.5, 1, 1.5]])  # shape: [2, 3]

# Evaluate this on a two observations, each in `R^3`, returning a length-2
# vector.
x = [[-1., 0, 1],
     [-11, 0, 11.]]   # shape: [2, 3].
mvn.prob(x).eval()    # shape: [2]
Аргументы
loc Вещественные числа с плавающей запятой. Если это установлено в None, loc подразумевается 0. При указании может иметь размерность [B1, ..., Bb, k], где b >= 0 и k — размер события.
scale_diag Положительные вещественные числа с плавающей запятой, представляющие диагональную матрицу, добавляемую к scale. Может иметь размерность [B1, ..., Bb, k], b >= 0, и характеризует b-пакеты k x k диагональных матриц, добавляемых к scale. Если и scale_identity_multiplier, и scale_diag являются None, то scale является Identity.
scale_identity_multiplier Положительные вещественные числа с плавающей запятой, представляющие матрицу, масштабированную по диагонали, добавляемую к scale. Может иметь размерность [B1, ..., Bb], b >= 0, и характеризует b-пакеты масштабированных k x k единичных матриц, добавляемых к scale. Если и scale_identity_multiplier, и scale_diag являются None, то scale является Identity.
validate_args Значение типа Python, по умолчанию False. Когда True параметры распределения проверяются на валидность, несмотря на то, что это может ухудшить производительность во время выполнения. При False неверные входные данные могут незаметно привести к неправильным выходным данным.
allow_nan_stats Значение типа Python, по умолчанию True. При True, статистические данные (например, среднее, мода, дисперсия) используют значение "NaN" для обозначения того, что результат не определен. При False, возникает исключение, если один или несколько членов пакетной статистики не определены.
name Имя типа Python, добавляемое к операциям, созданным этим классом.
Возможные исключения
ValueError если указан максимум scale_identity_multiplier аргумент.
Атрибуты
allow_nan_stats Значение типа Python, описывающее поведение, когда статистика не определена.

Статистики возвращают +/- бесконечность, когда это имеет смысл. Например, дисперсия распределения Коши равна бесконечности. Однако иногда статистика не определена, например, если функция плотности распределения не достигает максимума в пределах области определения распределения, мода не определена. Если среднее значение не определено, то, по определению, дисперсия не определена. Например, среднее значение для распределения Стьюдента при df = 1 не определено (нет ясного способа сказать, что это либо +∞, либо -∞), поэтому дисперсия = E[(X - среднее)**2] также не определена.

batch_shape Размер одного образца из одного индекса события в виде TensorShape.

Может быть частично определен или неизвестен.

Размер пакетных измерений — индексы независимых, нетождественных параметризаций этого распределения.

bijector Функция, преобразующая x в y.
distribution Базовое распределение, p(x).
dtype DType Tensor обрабатываемые этим Distribution.
event_shape Размер одного образца из одного пакета в виде TensorShape.

Может быть частично определен или неизвестен.

loc loc Tensor в Y = scale @ X + loc.
name Префикс имени ко всем операциям, созданным этим Distribution.
parameters Словарь параметров, используемых для создания экземпляра этого Distribution.
reparameterization_type Описывает, как образцы из распределения перепараметризованы.

В настоящее время это один из статических экземпляров distributions.FULLY_REPARAMETERIZED или distributions.NOT_REPARAMETERIZED.

scale scale LinearOperator в Y = scale @ X + loc.
validate_args Значение типа Python, указывающее, что, возможно, сложные проверки включены.

Методы

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

Размер одного образца из одного индекса события в виде одномерного Tensor.

Размер пакетных измерений — индексы независимых, нетождественных параметризаций этого распределения.

Аргументы
name имя, присваиваемое операции
Возвращаемое значение
batch_shape Tensor.

cdf

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

cdf(
    value, name='cdf'
)

Функция кумулятивного распределения.

Для случайной величины X, функция кумулятивного распределения cdf имеет вид:

cdf(x) := P[X <= x]
Аргументы
value float или double Tensor.
name Строковое значение типа Python, добавляемое к именам операций, созданных этой функцией.
Возвращаемое значение
cdf тензор размера sample_shape(x) + self.batch_shape со значениями типа self.dtype.

copy

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

copy(
    **override_parameters_kwargs
)

Создает глубокую копию распределения.

Примечание: скопированное распределение может продолжать зависеть от исходных аргументов инициализации.
Аргументы
**override_parameters_kwargs Словарь/значение словаря для инициализации, значения которого будут переопределять исходные значения.
Возвращаемое значение
distribution Новый экземпляр type(self), инициализированный из объединения self.parameters и override_parameters_kwargs, т.е., dict(self.parameters, **override_parameters_kwargs).

covariance

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

covariance(
    name='covariance'
)

Ковариация.

Ковариация определена (возможно) только для распределений со значениями событий, отличными от скалярных.

Например, для распределения с вектором длины k, оно вычисляется как,

Cov[i, j] = Covariance(X_i, X_j) = E[(X_i - E[X_i]) (X_j - E[X_j])]

где Cov — (пакетная) k x k матрица, 0 <= (i, j) < k, и E обозначает математическое ожидание.

В качестве альтернативы, для не-векторных, многомерных распределений (например, матричных, Вишарта), Covariance возвращает (пакетную) матрицу при некоторой векторизации событий, т.е.,

Cov[i, j] = Covariance(Vec(X)_i, Vec(X)_j) = [as above]

где Cov — (пакетная) k' x k' матрица, 0 <= (i, j) < k' = reduce_prod(event_shape), и Vec — некоторая функция, отображающая индексы размерностей события этого распределения на индексы вектора длины k'.

END_OF_DOCUMENT_MARKER
Аргументы
name Python str добавленный в имена операций, созданных этой функцией.
Возвращает
covariance Вещественное значение Tensor с формой [B1, ..., Bn, k', k'], где первые n измерения — координаты пакета, а k' = reduce_prod(self.event_shape).

cross_entropy

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

cross_entropy(
    other, name='cross_entropy'
)

Вычисляет перекрёстную энтропию (по Шеннону).

Обозначим данное распределение (self) как P, а распределение other — как Q. Предполагая, что P, Q абсолютно непрерывны относительно друг друга и допускают плотности p(x) dr(x) и q(x) dr(x), перекрёстная энтропия (по Шеннону) определяется следующим образом:

H[P, Q] = E_p[-log q(X)] = -int_F p(x) log q(x) dr(x)

где F обозначает область определения случайной величины X ~ P.

Аргументы
other Экземпляр класса tfp.distributions.Distribution.
name Python str добавленный в имена операций, созданных этой функцией.
Возвращает
cross_entropy Вещественное значение self.dtype Tensor с формой [B1, ..., Bn], представляющее собой n различные вычисления перекрёстной энтропии (по Шеннону).

entropy

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

entropy(
    name='entropy'
)

Энтропия Шеннона в натах.

event_shape_tensor

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

event_shape_tensor(
    name='event_shape_tensor'
)

Форма единственного выборки из одного пакета как 1-мерный int32 Tensor.

Аргументы
name имя операции
Возвращает
event_shape Tensor.

is_scalar_batch

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

is_scalar_batch(
    name='is_scalar_batch'
)

Указывает, что batch_shape == [].

Аргументы
name Python str добавленный в имена операций, созданных этой функцией.
Возвращает
is_scalar_batch bool скаляр Tensor.

is_scalar_event

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

is_scalar_event(
    name='is_scalar_event'
)

Указывает, что event_shape == [].

Аргументы
name Python str добавленный в имена операций, созданных этой функцией.
Возвращает
is_scalar_event bool скаляр Tensor.

kl_divergence

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

kl_divergence(
    other, name='kl_divergence'
)

Вычисляет расхождение Кульбака—Лейблера.

Обозначим данное распределение (self) как p, а распределение other — как q. Предполагая, что p, q абсолютно непрерывны относительно опорной меры r, расхождение Кульбака—Лейблера определяется как:

KL[p, q] = E_p[log(p(X)/q(X))]
         = -int_F p(x) log q(x) dr(x) + int_F p(x) log p(x) dr(x)
         = H[p, q] - H[p]

где F обозначает область определения случайной величины X ~ p, H[., .] обозначает (перекрёстную) энтропию Шеннона, а H[.] обозначает (перекрёстную) энтропию Шеннона.

Аргументы
other Экземпляр класса tfp.distributions.Distribution.
name Python str добавленный в имена операций, созданных этой функцией.
Возвращает
kl_divergence Вещественное значение self.dtype Tensor с формой [B1, ..., Bn], представляющее собой n различные вычисления расхождения Кульбака—Лейблера.

log_cdf

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

log_cdf(
    value, name='log_cdf'
)

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

Для случайной величины X, кумулятивная функция распределения cdf имеет вид:

log_cdf(x) := Log[ P[X <= x] ]

Часто для log_cdf(x) используется численное приближение, которое даёт более точный результат, чем просто взятие логарифма от cdf при x << -1.

Аргументы
value float или double Tensor.
name Python str добавленный в имена операций, созданных этой функцией.
Возвращает
logcdf массив Tensor с формой sample_shape(x) + self.batch_shape и значениями типа self.dtype.

log_prob

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

log_prob(
    value, name='log_prob'
)

Логарифм функции плотности/массы вероятности.

Дополнительная документация от MultivariateNormalLinearOperator:

value — это пакетный вектор с совместимой формой, если value — это Tensor, чья форма может быть расширена до:

self.batch_shape + self.event_shape

или

[M1, ..., Mm] + self.batch_shape + self.event_shape
Аргументы
value float или double Tensor.
name Python str добавленный в имена операций, созданных этой функцией.
Возвращает
log_prob массив Tensor с формой sample_shape(x) + self.batch_shape и значениями типа self.dtype.

log_survival_function

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

log_survival_function(
    value, name='log_survival_function'
)

Логарифмическая функция выживаемости.

Для случайной величины X, функция выживаемости определяется как:

log_survival_function(x) = Log[ P[X > x] ]
                         = Log[ 1 - P[X <= x] ]
                         = Log[ 1 - cdf(x) ]

Обычно используются различные численные приближения для логарифмической функции выживаемости, которые точнее, чем 1 - cdf(x) при x >> 1.

Аргументы
value float или double Tensor.
name Python str добавленный в имена операций, созданных этой функцией.
Tensor с формой sample_shape(x) + self.batch_shape и значениями типа self.dtype.

mean

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

mean(
    name='mean'
)

Среднее значение.

mode

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

mode(
    name='mode'
)

Мода.

param_shapes

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

@classmethod
param_shapes(
    sample_shape, name='DistributionParamShapes'
)

Формы параметров при заданной форме вызова sample().

Это метод класса, который описывает, какие аргументы ключ/значение необходимы для создания экземпляра данного Distribution, чтобы для вызова sample() этим экземпляром возвращалась определённая форма.

Подклассы должны переопределять метод класса _param_shapes.

Аргументы
sample_shape Tensor или список/кортеж Python. Желаемая форма вызова sample() .
name имя для добавления в начало операций.
Возвращаемое значение
Словарь dict имени параметра к формам Tensor .

param_static_shapes

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

@classmethod
param_static_shapes(
    sample_shape
)

param_shapes со статическими (т. е. TensorShape) формами.

Это метод класса, который описывает, какие аргументы ключ/значение необходимы для создания экземпляра данного Distribution, чтобы для вызова sample() этим экземпляром возвращалась определённая форма. Предполагается, что форма выборки известна статически.

Подклассы должны переопределять метод класса _param_shapes для возврата тензоров с постоянными значениями при подаче постоянных значений.

Аргументы
sample_shape TensorShape или список/кортеж Python. Желаемая форма вызова sample() .
Возвращаемое значение
Словарь dict имени параметра к формам TensorShape .
Исключения
ValueError если sample_shape является TensorShape и не полностью определён.

prob

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

prob(
    value, name='prob'
)

Функция плотности/массы вероятности.

Дополнительная документация из MultivariateNormalLinearOperator:

value — это вектор пакетной формы, совместимый по форме, если value — это Tensor форма которого может быть расширена до:

self.batch_shape + self.event_shape

или

[M1, ..., Mm] + self.batch_shape + self.event_shape
Аргументы
value float или double Tensor .
name Строка Python, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
prob тензор Tensor формы sample_shape(x) + self.batch_shape с значениями типа self.dtype .

quantile

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

quantile(
    value, name='quantile'
)

Функция квантиля. Также известна как "обратная функция распределения" или "функция процентиля".

Для случайной величины X и p in [0, 1], quantile:

quantile(p) := x such that P[X <= x] == p
Аргументы
value float или double Tensor .
name Строка Python, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
quantile тензор Tensor формы sample_shape(x) + self.batch_shape с значениями типа self.dtype .

sample

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

sample(
    sample_shape=(), seed=None, name='sample'
)

Генерирует образцы заданной формы.

Обратите внимание, что вызов sample() без аргументов сгенерирует один образец.

Аргументы
sample_shape 0D или 1D int32 Tensor . Форма генерируемых образцов.
seed Целое число Python, используемое как seed для генератора случайных чисел.
name имя для операции.
Возвращаемое значение
samples тензор Tensor с добавленными перед измерениями sample_shape .

stddev

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

stddev(
    name='stddev'
)

Среднее квадратичное отклонение.

Среднее квадратичное отклонение определяется как,

stddev = E[(X - E[X])**2]**0.5

где X — случайная величина, связанная с этим распределением, E обозначает математическое ожидание, и stddev.shape = batch_shape + event_shape.

Аргументы
name Строка Python, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
stddev Плавающее число Tensor с формой, идентичной batch_shape + event_shape, т. е. той же формой, что и self.mean() .

survival_function

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

survival_function(
    value, name='survival_function'
)

Функция выживаемости.

Для случайной величины X, функция выживаемости определяется:

survival_function(x) = P[X > x]
                     = 1 - P[X <= x]
                     = 1 - cdf(x).
Аргументы
value float или double Tensor .
name Строка Python, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
тензор Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype .

variance

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

variance(
    name='variance'
)

Дисперсия.

Дисперсия определяется как,

Var = E[(X - E[X])**2]

где X — случайная величина, связанная с этим распределением, E обозначает математическое ожидание, и Var.shape = batch_shape + event_shape.

Аргументы
name Строка Python, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
variance Плавающее число Tensor с формой, идентичной batch_shape + event_shape, т. е. той же формой, что и self.mean() .

© 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/contrib/distributions/MultivariateNormalDiag

Spec-Zone.ru

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