tf.compat.v1.distributions.DirichletMultinomial

Совместное распределение Дирихле-многономиального типа.

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

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

Распределение Дирихле-многономиального типа параметризуется (пачкой) векторов длины K concentration (K > 1) и числом испытаний total_count, т.е., числом испытаний на каждую выборку из DirichletMultinomial. Оно определено над (пачкой) вектором длины K counts, таким что tf.reduce_sum(counts, -1) = total_count. Распределение Дирихле-многономиального типа идентично распределению Бета-биномиального типа, когда K = 2.

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

Распределение Дирихле-многономиального типа является распределением по K классам, т.е., вектору длины K из неотрицательных целых counts = n = [n_0, ..., n_{K-1}].

Функция вероятности (pmf) имеет вид,

pmf(n; alpha, N) = Beta(alpha + n) / (prod_j n_j!) / Z
Z = Beta(alpha) / N!

где:

• concentration = alpha = [alpha_0, ..., alpha_{K-1}], alpha_j > 0,
• total_count = N, N - положительное целое число,
• N! - это N факториал, и,
• Beta(x) = prod_j Gamma(x_j) / Gamma(sum_j x_j) - это многомерная бета-функция, и,
• Gamma - это гамма-функция.

Распределение Дирихле-многономиального типа является составным распределением, т.е., его выборки генерируются следующим образом.

1. Выберите вероятности классов: probs = [p_0,...,p_{K-1}] ~ Dir(concentration)
2. Сгенерируйте целые числа: counts = [n_0,...,n_{K-1}] ~ Multinomial(total_count, probs)

Последнее concentration измерение параметризует отдельное распределение Дирихле-многономиального типа. При вызове функций распределения (например, dist.prob(counts)), concentration, total_count и counts транслируются до одинаковой формы. Последнее измерение counts соответствует отдельным распределениям Дирихле-многономиального типа.

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

Опасности

Количество классов, K, не должно превышать:

• наибольшего целого числа, представимого в self.dtype, т.е., 2**(mantissa_bits+1) (IEE754),
• максимального индекса Tensor, т.е., 2**31-1.

Другими словами,

K <= min(2**31-1, {
  tf.float16: 2**11,
  tf.float32: 2**24,
  tf.float64: 2**53 }[param.dtype])

Примечание: Это условие проверяется только при self.validate_args = True.

Примеры

alpha = [1., 2., 3.]
n = 2.
dist = DirichletMultinomial(n, alpha)

Создает распределение по 3 классам, при этом вероятность выбора 3-го класса наиболее высока. Функции распределения могут быть вычислены для счётчиков.

# counts same shape as alpha.
counts = [0., 0., 2.]
dist.prob(counts)  # Shape []

# alpha will be broadcast to [[1., 2., 3.], [1., 2., 3.]] to match counts.
counts = [[1., 1., 0.], [1., 0., 1.]]
dist.prob(counts)  # Shape [2]

# alpha will be broadcast to shape [5, 7, 3] to match counts.
counts = [[...]]  # Shape [5, 7, 3]
dist.prob(counts)  # Shape [5, 7]

Создаёт 2 набора распределений по 3 классам.

alpha = [[1., 2., 3.], [4., 5., 6.]]  # Shape [2, 3]
n = [3., 3.]
dist = DirichletMultinomial(n, alpha)

# counts will be broadcast to [[2., 1., 0.], [2., 1., 0.]] to match alpha.
counts = [2., 1., 0.]
dist.prob(counts)  # Shape [2]

Методы

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

cdf

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

cdf(
    value, name='cdf'
)

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

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

cdf(x) := P[X <= x]

copy

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

copy(
    **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'.

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

Ковариация для каждого элемента группы определяется следующим образом:

Var(X_j) = n * alpha_j / alpha_0 * (1 - alpha_j / alpha_0) *
(n + alpha_0) / (1 + alpha_0)

где concentration = alpha и total_concentration = alpha_0 = sum_j alpha_j.

Ковариация между элементами в группе определяется как:

Cov(X_i, X_j) = -n * alpha_i * alpha_j / alpha_0 ** 2 *
(n + alpha_0) / (1 + alpha_0)

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.

entropy

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

entropy(
    name='entropy'
)

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

event_shape_tensor

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

event_shape_tensor(
    name='event_shape_tensor'
)

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

is_scalar_batch

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

is_scalar_batch(
    name='is_scalar_batch'
)

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

is_scalar_event

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

is_scalar_event(
    name='is_scalar_event'
)

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

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[.] обозначает энтропию (Шеннона).

log_cdf

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

log_cdf(
    value, name='log_cdf'
)

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

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

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

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

log_prob

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

log_prob(
    value, name='log_prob'
)

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

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

Для каждой группы счётчиков value = [n_0, ..., n_{K-1}], P[value] — это вероятность того, что после выборки self.total_count из этого распределения Дирихле-многономиального распределения, число выборок, попавших в класс j, будет равно n_j. Поскольку это определение является обмениваемым, разные последовательности имеют одинаковые счётчики, поэтому вероятность включает комбинаторный коэффициент.

Примечание: value должен быть неотрицательным тензором типа self.dtype, не иметь дробных компонентов и таким, чтобы tf.reduce_sum(value, -1) = self.total_count. Его форма должна быть совместима с self.concentration и self.total_count.

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.

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

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

mean(
    name='mean'
)

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

Мода

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

mode(
    name='mode'
)

Мода.

param_shapes

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

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

Формы параметров, учитывая желаемую форму вызова sample().

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

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

param_static_shapes

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

@classmethod
param_static_shapes(
    sample_shape
)

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

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

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

Функция вероятности

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

prob(
    value, name='prob'
)

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

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

Для каждого набора подсчетов value = [n_0, ..., n_{K-1}], P[value] — это вероятность того, что после выборки self.total_count извлечений из этого распределения Дирихле-многономиального распределения, количество извлечений, попавших в класс j, равно n_j. Поскольку это определение является взаимозаменяемым; различные последовательности имеют одинаковые значения, поэтому вероятность включает комбинаторный коэффициент.

Примечание: value должно быть неотрицательным тензором типа self.dtype, не иметь дробных компонент и таким образом, что tf.reduce_sum(value, -1) = self.total_count. Его форма должна быть совместима с self.concentration и self.total_count.

Квантиль

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

quantile(
    value, name='quantile'
)

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

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

quantile(p) := x such that P[X <= x] == p

Выборка

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

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

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

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

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

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

stddev(
    name='stddev'
)

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

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

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

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

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

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

survival_function(
    value, name='survival_function'
)

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

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

survival_function(x) = P[X > x]
                     = 1 - P[X <= x]
                     = 1 - cdf(x).

Дисперсия

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

variance(
    name='variance'
)

Дисперсия.

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

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

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