Spec-Zone.ru › TensorFlow 1.15

tf.contrib.distributions.HalfNormal

Распределение Гаусса с половинной нормой со масштабом scale.

Наследуется от: Distribution

tf.contrib.distributions.HalfNormal(
    scale, validate_args=False, allow_nan_stats=True, name='HalfNormal'
)

Математические детали

Распределение полунормального является преобразованием распределения нормального распределения. Если случайная величина X имеет нормальное распределение,

X ~ Normal(0.0, scale)
Y = |X|

Тогда Y будет иметь распределение полунормального. Плотность вероятности (pdf) равна:

pdf(x; scale, x > 0) = sqrt(2) / (scale * sqrt(pi)) *
  exp(- 1/2 * (x / scale) ** 2)
)

Где scale = sigma - стандартное отклонение основного нормального распределения.

Примеры

Примеры инициализации одного или нескольких распределений.

import tensorflow_probability as tfp
tfd = tfp.distributions

# Define a single scalar HalfNormal distribution.
dist = tfd.HalfNormal(scale=3.0)

# Evaluate the cdf at 1, returning a scalar.
dist.cdf(1.)

# Define a batch of two scalar valued HalfNormals.
# The first has scale 11.0, the second 22.0
dist = tfd.HalfNormal(scale=[11.0, 22.0])

# Evaluate the pdf of the first distribution on 1.0, and the second on 1.5,
# returning a length two tensor.
dist.prob([1.0, 1.5])

# Get 3 samples, returning a 3 x 2 tensor.
dist.sample([3])
Args
scale Вещественный тензор; масштабы распределения(й). Должен содержать только положительные значения.
validate_args Python bool, по умолчанию False. Когда параметры распределения True проверяются на корректность, несмотря на возможную ухудшение производительности во время выполнения. Когда False некорректные входные данные могут безмолвно привести к неверным выходным данным.
allow_nan_stats Python bool, по умолчанию True. Когда True, статистики (например, среднее значение, мода, дисперсия) используют значение "NaN" для указания того, что результат не определен. Когда False, генерируется исключение, если один или несколько элементов статистической выборки не определены.
name Python str имя, добавленное к операциям, созданным этим классом.
Attributes
allow_nan_stats Python bool описывает поведение, когда статистическая величина не определена.

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

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

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

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

dtype DType Tensor обрабатывается этим Distribution.
event_shape Форма одного образца из одного пакета в виде TensorShape.

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

name Имя, добавляемое ко всем операциям, созданным этим Distribution.
parameters Словарь параметров, используемых для инициализации этого Distribution.
reparameterization_type Описывает, как образцы из распределения перепараметризуются.

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

scale Параметр распределения для масштаба.
validate_args Python bool указывающий на то, что, возможно, дорогостоящие проверки включены.

Методы

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

Args
name имя, присваиваемое операции
Возвращает
batch_shape Tensor.

cdf

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

cdf(
    value, name='cdf'
)

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

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

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

copy

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

copy(
    **override_parameters_kwargs
)

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

Примечание: распределение копии может продолжать зависеть от исходных аргументов инициализации.
Args
**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'.

Args
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.

Args
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-мерного Tensor.

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

is_scalar_batch

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

is_scalar_batch(
    name='is_scalar_batch'
)

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

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

is_scalar_event

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

is_scalar_event(
    name='is_scalar_event'
)

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

Аргументы
name Python-строка, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
is_scalar_event скалярное 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-строка, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
kl_divergence тензор Tensor со значениями, представляющими различные вычисления расхождения Кульбака—Лейблера.

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-строка, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
logcdf тензор Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype.

log_prob

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

log_prob(
    value, name='log_prob'
)

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

Аргументы
value float или double Tensor.
name Python-строка, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
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-строка, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
тензор 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 форма вызова sample() или список/кортеж Python.
name имя для добавления в операции.
Возвращаемое значение
словарь соответствия имен параметров и их форм.

param_static_shapes

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

@classmethod
param_static_shapes(
    sample_shape
)

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

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

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

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

prob

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

prob(
    value, name='prob'
)

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

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

quantile

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

quantile(
    value, name='quantile'
)

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

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

quantile(p) := x such that P[X <= x] == p
Аргументы
value float или double Tensor.
name Python str добавленное к именам операций, созданных этой функцией.
Возвращаемое значение
quantile a 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-семя для генератора случайных чисел
name Имя для операции.
Возвращаемое значение
samples a 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 str добавленное к именам операций, созданных этой функцией.
Возвращаемое значение
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 str добавленное к именам операций, созданных этой функцией.
Возвращаемое значение
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 str добавленное к именам операций, созданных этой функцией.
Возвращаемое значение
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/HalfNormal

Spec-Zone.ru

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