Spec-Zone.ru › TensorFlow 2.9

tf.compat.v1.distributions.Gamma

Распределение Гамма.

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

tf.compat.v1.distributions.Gamma(
    concentration,
    rate,
    validate_args=False,
    allow_nan_stats=True,
    name='Gamma'
)

Распределение Гамма определено на положительных действительных числах с использованием параметров concentration (также «альфа») и rate (также «бета»).

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

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

pdf(x; alpha, beta, x > 0) = x**(alpha - 1) exp(-x beta) / Z
Z = Gamma(alpha) beta**(-alpha)

где:

  • concentration = alpha, alpha > 0,
  • rate = beta, beta > 0,
  • Z является нормирующей константой, и,
  • Gamma — это гамма-функция.

Функция кумулятивного распределения (cdf) равна,

cdf(x; alpha, beta, x > 0) = GammaInc(alpha, beta x) / Gamma(alpha)

где GammaInc — это неполная гамма-функция.

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

concentration = alpha = (mean / stddev)**2
rate = beta = mean / stddev**2 = concentration / mean

Параметры распределения автоматически передаются во всех функциях; см. примеры для получения подробностей.

Предупреждение: Образцы этого распределения всегда неотрицательны. Однако образцы, которые меньше np.finfo(dtype).tiny, округляются до этого значения, поэтому их встречается больше, чем должно быть. Это должно быть заметно только тогда, когда concentration очень мало или rate очень велико. См. примечание в tf.random.gamma строке документации.

Образцы этого распределения переопределены (путевая дифференцируемость). Производные вычисляются с использованием подхода, описанного в (Figurnov et al., 2018).

Примеры

import tensorflow_probability as tfp
tfd = tfp.distributions

dist = tfd.Gamma(concentration=3.0, rate=2.0)
dist2 = tfd.Gamma(concentration=[3.0, 4.0], rate=[2.0, 3.0])

Вычислите градиенты образцов по отношению к параметрам:

concentration = tf.constant(3.0)
rate = tf.constant(2.0)
dist = tfd.Gamma(concentration, rate)
samples = dist.sample(5)  # Shape [5]
loss = tf.reduce_mean(tf.square(samples))  # Arbitrary loss function
# Unbiased stochastic gradients of the loss function
grads = tf.gradients(loss, [concentration, rate])

Ссылки:

Неявные градиенты перепараметризации: Figurnov et al., 2018 (pdf)

Аргументы
concentration Вещественный тензор, параметры концентрации распределения(ий). Должны содержать только положительные значения.
rate Вещественный тензор, параметры обратной шкалы распределения(ий). Должны содержать только положительные значения.
validate_args Python bool, по умолчанию False. Когда True параметры распределения проверяются на корректность, несмотря на то, что это может ухудшить производительность во время выполнения. Когда False некорректные входные данные могут бесшумно привести к неверным результатам.
allow_nan_stats Python bool, по умолчанию True. Когда True, для статистических данных (например, среднего, моды, дисперсии) используется значение «NaN», чтобы указать, что результат не определен. Когда False, если один или несколько элементов набора статистических данных не определены, генерируется исключение.
name Python str имя, добавляемое в качестве префикса к операциям, созданным этим классом.
Исключения
TypeError если concentration и rate имеют разные типы данных.
Атрибуты
allow_nan_stats Python bool, описывающий поведение при неопределенности статистики.

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

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

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

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

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

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

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

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

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 тензор Tensor с форматом 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 Вещественный 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 Префикс для имён операций, созданных этой функцией.
Возвращаемое значение
cross_entropy Численное значение self.dtype Tensor с формой [B1, ..., Bn], представляющее n различные вычисления (шанноновской) кросс-энтропии.

data-text="entropy" id="entropy">entropy

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

entropy(
    name='entropy'
)

Шэнноновская энтропия в натах.

data-text="event_shape_tensor" id="event_shape_tensor">event_shape_tensor

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

event_shape_tensor(
    name='event_shape_tensor'
)

Форма одного образца из одной группы как 1-мерный целочисленный Tensor.

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

data-text="is_scalar_batch" id="is_scalar_batch">is_scalar_batch

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

is_scalar_batch(
    name='is_scalar_batch'
)

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

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

data-text="is_scalar_event" id="is_scalar_event">is_scalar_event

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

is_scalar_event(
    name='is_scalar_event'
)

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

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

data-text="kl_divergence" id="kl_divergence">kl_divergence

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

kl_divergence(
    other, name='kl_divergence'
)

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

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

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 Префикс для имён операций, созданных этой функцией.
Возвращаемое значение
kl_divergence Численное значение self.dtype Tensor с формой [B1, ..., Bn], представляющее n различные вычисления расстояния Кульбака—Лайблера.

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

data-text="log_prob" id="log_prob">log_prob

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

log_prob(
    value, name='log_prob'
)

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

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

data-text="log_survival_function" id="log_survival_function">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 Префикс для имён операций, созданных этой функцией.
Tensor с формой sample_shape(x) + self.batch_shape и значениями типа self.dtype.

data-text="mean" id="mean">mean

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

mean(
    name='mean'
)

Математическое ожидание.

data-text="mode" id="mode">mode

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

mode(
    name='mode'
)

Мода.

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

Мода распределения Гамма равна (shape - 1) / rate при shape > 1, и NaN в противном случае. Если self.allow_nan_stats равно False, будет возбуждено исключение вместо возвращения NaN.

data-text="param_shapes" id="param_shapes">param_shapes

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

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

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

Это метод класса, описывающий необходимые аргументы key/value для создания экземпляра данного 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'
)

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

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

sample

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

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

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

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

Аргументы
sample_shape 0-мерный или 1-мерный int32 Tensor. Форма генерируемых выборок.
seed Целое число Python, используемое как семя генератора псевдослучайных чисел.
name Имя операции.
Возвращаемое значение
samples тензор с добавленными в начале измерениями 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 Вещественный тензор формы, идентичной 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-строка, добавляемая как префикс к именам операций, созданных данной функцией.
Возвращаемое значение
Тензор формы 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 Вещественный тензор формы, идентичной batch_shape + event_shape, т. е. такой же формы, как self.mean().

© 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/compat/v1/distributions/Gamma

Spec-Zone.ru

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