Spec-Zone.ru › TensorFlow 1.15

tf.distributions.DirichletMultinomial

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

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

Просмотр псевдонимов

Основные псевдонимы

`tf.contrib.distributions.DirichletMultinomial`

Псевдонимы совместимости для миграции

См. Руководство по миграции для получения более подробной информации.

tf.compat.v1.distributions.DirichletMultinomial

tf.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]
Args
total_count Неотрицательный тензор с плавающей точкой, тип данных которого совпадает с типом concentration. Форма согласуется с [N1,..., Nm] с m >= 0. Определяет это как пакет из N1 x ... x Nm различных распределений Дирихле-многономиального типа. Его компоненты должны быть равны целым значениям.
concentration Положительный тензор с плавающей точкой, тип данных которого совпадает с типом n с формой, согласующейся с [N1,..., Nm, K] m >= 0. Определяет это как пакет из N1 x ... x Nm различных 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 Tensor обрабатываемый этим Distribution.
event_shape Форма одиночной выборки из одной партии в виде TensorShape.

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

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

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

total_concentration Сумма последнего измерения параметра концентрации.
total_count Количество испытаний, используемых для создания выборки.
validate_args Python bool, указывающий, что возможно включены дорогостоящие проверки.

Методы

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

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

cdf

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

cdf(
    value, name='cdf'
)

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

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

cdf(x) := P[X <= x]
Args
value float или double Tensor.
name Python str имя, добавляемое к операциям, созданным этой функцией.
Возвращает
cdf тензор формы sample_shape(x) + self.batch_shape со значениями типа self.dtype.

copy

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

copy(
    **override_parameters_kwargs
)

Создаёт глубокую копию распределения.

Примечание: распределение копии может по-прежнему зависеть от исходных аргументов инициализации.
Args
**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 обозначает математическое ожидание.

В качестве альтернативы, для невекторных многомерных распределений (например, матричнозначных, Wishart), 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)
Аргументы
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 различные вычисления (энтропии Шеннона) перекрёстной энтропии.

entropy

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

entropy(
    name='entropy'
)

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

event_shape_tensor

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

event_shape_tensor(
    name='event_shape_tensor'
)

Форма одного образца из одного пакета как целочисленное значение 1-D int32 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 определяется как:

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

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

Дополнительная документация из 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.
Аргументы
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.

Args
value float или double Tensor.
name Python str добавляется к именам операций, созданных этой функцией.
Returns
Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype.

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

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

mean(
    name='mean'
)

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

Режим

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

mode(
    name='mode'
)

Режим.

param_shapes

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

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

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

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

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

Args
sample_shape Tensor или список/кортеж Python. Желаемая форма вызова sample().
name имя для добавления к операциям.
Returns
dict имени параметра к формам Tensor .

param_static_shapes

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

@classmethod
param_static_shapes(
    sample_shape
)

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

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

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

Args
sample_shape TensorShape или список/кортеж Python. Желаемая форма вызова sample().
Returns
dict имени параметра к TensorShape.
Raises
ValueError если TensorShape является sample_shape и не определён полностью.

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

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

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

Квантиль

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

quantile(
    value, name='quantile'
)

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

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

quantile(p) := x such that P[X <= x] == p
Args
value float или double Tensor.
name Python str добавляется к именам операций, созданных этой функцией.
Returns
quantile Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype.

Пример

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

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

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

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

Args
sample_shape 0D или 1D int32 Tensor. Форма генерируемых образцов.
seed целое число Python, служащее семеном для ГСЧ
name имя для присвоения операции.
Returns
samples Tensor с добавленными измерениями sample_shape.

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

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

stddev(
    name='stddev'
)

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

Стандартное отклонение определяется как:

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

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

Args
name Python str добавляется к именам операций, созданных этой функцией.
Returns
stddev число с плавающей точкой Tensor со формой, идентичной batch_shape + event_shape, т.е. той же формы, что и self.mean().

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

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

survival_function(
    value, name='survival_function'
)

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

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

survival_function(x) = P[X > x]
                     = 1 - P[X <= x]
                     = 1 - cdf(x).
Args
value float или double Tensor.
name Python str добавляется к именам операций, созданных этой функцией.
Returns
Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype.

Дисперсия

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

variance(
    name='variance'
)

Дисперсия.

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

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

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

Args
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/r1.15/api_docs/python/tf/distributions/DirichletMultinomial

Spec-Zone.ru

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