tf.compat.v1.distributions.Multinomial

Мультиномиальное распределение.

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

tf.compat.v1.distributions.Multinomial(
    total_count,
    logits=None,
    probs=None,
    validate_args=False,
    allow_nan_stats=True,
    name='Multinomial'
)

Это мультиномиальное распределение параметризуется с помощью probs — вектора(ов) (вероятностей) длины K prob (для пакета) (K > 1), такого(их), что tf.reduce_sum(probs, -1) = 1, и total_count числа испытаний, то есть числа испытаний для каждого извлечения из мультиномиального распределения. Оно определено на векторе counts длины K (для пакета), таком, что tf.reduce_sum(counts, -1) = total_count. При K = 2 мультиномиальное распределение совпадает с биномиальным распределением.

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

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

Функция вероятностной массы (pmf) имеет вид:

pmf(n; pi, N) = prod_j (pi_j)**n_j / Z
Z = (prod_j n_j!) / N!

где:

• probs = pi = [pi_0, ..., pi_{K-1}], pi_j > 0, sum_j pi_j = 1,
• total_count = N, N — положительное целое число,
• Z — нормирующая константа, и
• N! обозначает факториал N.

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

Подводные камни

Число классов, 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.

Примеры

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

logits = [-50., -43, 0]
dist = Multinomial(total_count=4., logits=logits)

Создайте распределение с 3 классами, где вероятность извлечения элемента из 3-го класса наибольшая.

p = [.2, .3, .5]
dist = Multinomial(total_count=4., probs=p)

Функции распределения можно вычислять для заданных количеств элементов.

# counts same shape as p.
counts = [1., 0, 3]
dist.prob(counts)  # Shape []

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

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

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

p = [[.1, .2, .7], [.3, .3, .4]]  # Shape [2, 3]
dist = Multinomial(total_count=[4., 5], probs=p)

counts = [[2., 1, 1], [3, 1, 1]]
dist.prob(counts)  # Shape [2]

dist.sample(5) # Shape [5, 2, 3]

Методы

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

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'
)

Форма одной выборки для одного пакета в виде одномерного тензора int32 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'
)

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

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

Для каждого пакета количеств элементов 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.probs и 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

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

mean(
    name='mean'
)

Среднее.

mode

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

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

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

prob(
    value, name='prob'
)

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

quantile

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

quantile(
    value, name='quantile'
)

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

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

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

sample

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

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

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

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

stddev

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

stddev(
    name='stddev'
)

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

Стандартное отклонение определяется следующим образом:

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

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

survival_function

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

survival_function(
    value, name='survival_function'
)

Функция выживания.

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

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

variance

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

variance(
    name='variance'
)

Дисперсия.

Дисперсия определяется следующим образом:

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

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