Spec-Zone.ru › TensorFlow 2.3

tf.compat.v1.distributions.Laplace

Распределение Лапласа с параметрами расположения loc и scale.

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

tf.compat.v1.distributions.Laplace(
    loc, scale, validate_args=False, allow_nan_stats=True, name='Laplace'
)

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

Функция плотности вероятности (pdf) этого распределения:

pdf(x; mu, sigma) = exp(-|x - mu| / sigma) / Z
Z = 2 sigma

где loc = mu, scale = sigma, и Z — константа нормировки.

Обратите внимание, что распределение Лапласа можно рассматривать как два экспоненциальных распределения, соединённых «головой к хвосту».

Распределение Лапласа является членом семейства распределений по местоположению и масштабу, то есть его можно построить как:

X ~ Laplace(loc=0, scale=1)
Y = loc + scale * X
Аргументы
loc Вещественный тензор, характеризующий расположение (центр) распределения.
scale Положительный вещественный тензор, характеризующий разброс распределения.
validate_args Python bool, по умолчанию False. Когда параметры распределения True проверяются на корректность, несмотря на возможное ухудшение производительности во время выполнения. Когда False неверные входные данные могут в тишине привести к некорректным результатам.
allow_nan_stats Python bool, по умолчанию True. Когда True, статистические данные (например, среднее значение, мода, дисперсия) используют значение «NaN», чтобы указать, что результат не определён. Когда False, возникает исключение, если один или несколько членов пакетной статистики не определены.
name Python str имя, добавляемое как префикс к операциям, созданным этим классом.
Возбуждает
TypeError если loc и scale имеют разный тип данных.
Атрибуты
allow_nan_stats Python bool, описывающий поведение при неопределённом значении статистики.

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

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

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

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

dtype Размерность DType Tensors, обрабатываемых этим Distribution.
event_shape Форма одного образца из одного набора в виде TensorShape.

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

loc Параметр распределения для расположения.
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.

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

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

cdf

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

cdf(
    value, name='cdf'
)

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

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

cdf(x) := P[X <= x]
Аргументы
value float или double Tensor.
name Python str префикс к именам операций, созданных этой функцией.
Возвращает
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'.

Аргументы
name Python str префикс к именам операций, созданных этой функцией.
Возвращает
covariance Вещественный тензор с формой [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 Вещественный тензор с формой [B1, ..., Bn] представляющий собой различные вычисления перекрёстной энтропии (Шеннона).

entropy

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

entropy(
    name='entropy'
)

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

event_shape_tensor

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

event_shape_tensor(
    name='event_shape_tensor'
)

Форма одного образца из одной партии в виде одномерного целочисленного массива 32 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'
)

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

Аргументы
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 имя, добавляемое к операциям.
Возвращаемое значение
отображение от имени параметра к формам Tensor.

param_static_shapes

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

@classmethod
param_static_shapes(
    sample_shape
)

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

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

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

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

prob

Просмотр исходного кода

prob(
    value, name='prob'
)

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

Аргументы
value float или double Tensor.
name Python str добавляемый в начало имён операций, созданных этой функцией.
Возвращаемое значение
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 str добавляемый в начало имён операций, созданных этой функцией.
Возвращаемое значение
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 для начального значения генератора случайных чисел
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 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/r2.3/api_docs/python/tf/compat/v1/distributions/Laplace

Spec-Zone.ru

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