Spec-Zone.ru › TensorFlow 2.4

tf.compat.v1.distributions.Dirichlet

Распределение Дирихле.

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

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

Распределение Дирихле определено над (k-1)-симплексом с использованием положительного вектора длины k concentration (k > 1). Распределение Дирихле совпадает с бета-распределением, когда k = 2.

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

Распределение Дирихле является распределением над открытым (k-1)-симплексом, т.е.

S^{k-1} = { (x_0, ..., x_{k-1}) in R^k : sum_j x_j = 1 and all_j x_j > 0 }.

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

pdf(x; alpha) = prod_j x_j**(alpha_j - 1) / Z
Z = prod_j Gamma(alpha_j) / Gamma(sum_j alpha_j)

где:

  • x in S^{k-1}, т.е., (k-1)-симплекс,
  • concentration = alpha = [alpha_0, ..., alpha_{k-1}], alpha_j > 0,
  • Z является нормирующей константой, также известной как многомерная бета-функция, и,
  • Gamma является гамма-функцией.

concentration представляет собой среднее количество общих случаев появления классов, т.е.,

concentration = alpha = mean * total_concentration

где mean в S^{k-1} и total_concentration является положительным действительным числом, представляющим среднее общее количество.

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

Предупреждение: Некоторые компоненты выборок могут быть равны нулю из-за конечной точности. Это чаще происходит, когда некоторые концентрации очень малы. Убедитесь, что вы округляете выборки до np.finfo(dtype).tiny перед вычислением плотности.

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

Примеры

import tensorflow_probability as tfp
tfd = tfp.distributions

# Create a single trivariate Dirichlet, with the 3rd class being three times
# more frequent than the first. I.e., batch_shape=[], event_shape=[3].
alpha = [1., 2, 3]
dist = tfd.Dirichlet(alpha)

dist.sample([4, 5])  # shape: [4, 5, 3]

# x has one sample, one batch, three classes:
x = [.2, .3, .5]   # shape: [3]
dist.prob(x)       # shape: []

# x has two samples from one batch:
x = [[.1, .4, .5],
     [.2, .3, .5]]
dist.prob(x)         # shape: [2]

# alpha will be broadcast to shape [5, 7, 3] to match x.
x = [[...]]   # shape: [5, 7, 3]
dist.prob(x)  # shape: [5, 7]
# Create batch_shape=[2], event_shape=[3]:
alpha = [[1., 2, 3],
         [4, 5, 6]]   # shape: [2, 3]
dist = tfd.Dirichlet(alpha)

dist.sample([4, 5])  # shape: [4, 5, 2, 3]

x = [.2, .3, .5]
# x will be broadcast as [[.2, .3, .5],
#                         [.2, .3, .5]],
# thus matching batch_shape [2, 3].
dist.prob(x)         # shape: [2]

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

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

Ссылки:

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

Аргументы
concentration Положительное число с плавающей запятой Tensor, указывающее среднее количество случаев появления классов; также известный как «альфа». Подразумевает self.dtype, и self.batch_shape, self.event_shape, т.е., если concentration.shape = [N1, N2, ..., Nm, k] то batch_shape = [N1, N2, ..., Nm] и event_shape = [k].
validate_args Python bool, по умолчанию False. Когда True параметры распределения проверяются на корректность, несмотря на возможные ухудшения производительности. Когда False некорректные входные данные могут безмолвно привести к неверным результатам.
allow_nan_stats Python bool, по умолчанию True. Когда True, статистические данные (например, среднее значение, мода, дисперсия) используют значение «NaN» для обозначения того, что результат не определен. Когда False, возникает исключение, если один или несколько членов пакетной статистики не определены.
name Python str имя, добавляемое в префикс к операциям, созданным этим классом.
Атрибуты
allow_nan_stats Python bool описывающий поведение, когда статистическая информация не определена.

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

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

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

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

concentration Параметр концентрации; ожидаемое количество для этой координаты.
dtype DType Tensors, обрабатываемые этим Distribution.
event_shape Форма одной выборки из одного пакета в виде TensorShape.

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

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

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

total_concentration Сумма последнего измерения параметра концентрации.
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 Префикс Python str добавляется к именам операций, созданных этой функцией.
Возвращает
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 Префикс Python str добавляется к именам операций, созданных этой функцией.
Возвращает
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 Префикс Python str добавляется к именам операций, созданных этой функцией.
Возвращает
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 Префикс Python str добавляется к именам операций, созданных этой функцией.
Возвращает
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 Префикс Python str добавляется к именам операций, созданных этой функцией.
Возвращает
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'
)

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

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

Примечание: value должен быть неотрицательным тензором с типом self.dtype и находиться в (self.event_shape() - 1)-симплексе, то есть tf.reduce_sum(value, -1) = 1. Он должен иметь форму, совместимую с self.batch_shape() + self.event_shape().
Аргументы
value float или double Tensor.
name Префикс Python str добавляется к именам операций, созданных этой функцией.
Возвращает
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 Префикс Python str добавляется к именам операций, созданных этой функцией.
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'
)

Мода.

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

Примечание: Мода не определена, когда любые concentration <= 1. Если self.allow_nan_stats является True, NaN используется для неопределённых мод. Если self.allow_nan_stats является False, при попытке получить одну или несколько мод, возникает исключение.

data-text="param_shapes" id="param_shapes">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'
)

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

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

Примечание: value должен быть неотрицательным тензором типа self.dtype и находиться в (self.event_shape() - 1)-симплексе, т.е. tf.reduce_sum(value, -1) = 1. Он должен иметь форму, совместимую с self.batch_shape() + self.event_shape().
Аргументы
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(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 0D или 1D целочисленный int32 Tensor. Форма генерируемых образцов.
seed Целочисленное семя для генератора случайных чисел.
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().

© 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.4/api_docs/python/tf/compat/v1/distributions/Dirichlet

Spec-Zone.ru

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