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) и числом испытаний, т.е. числом испытаний на каждую выборку из 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— это гамма-функция
Дирихле-многономиальное — это сложное распределение, т.е. его выборки генерируются следующим образом.
- Выбрать вероятности классов:
probs = [p_0,...,p_{K-1}] ~ Dir(concentration) - Сгенерировать целые числа:
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 из Tensors, обрабатываемых этим Distribution. |
event_shape | Размер одной выборки из одного пакета в виде TensorShape. Может быть частично определён или неизвестен. |
name | Имя, добавляемое в качестве префикса ко всем операциям, созданным этим Distribution. |
parameters | Словарь параметров, используемых для создания этого Distribution. |
reparameterization_type | Описание того, как выборки из распределения репараметризуются. В настоящее время это один из статических экземпляров |
total_concentration | Сумма последнего измерения параметра концентрации. |
total_count | Число испытаний, используемых для построения выборки. |
validate_args | Python bool указывающее, что возможно дорогостоящие проверки включены. |
Методы
batch_shape_tensor
batch_shape_tensor(
name='batch_shape_tensor'
)
Размер одной выборки из одного индекса события в виде одномерного 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 обозначает математическое ожидание.
В качестве альтернативы, для не векторных, многомерных распределений (например, матричных, Вишарта), 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). |
data-text="cross_entropy" id="cross_entropy">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'
)
Форма одной выборки из одного набора в виде одномерного целочисленного массива 32-битного типа 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'
)
Логарифмическая функция плотности/массы вероятности.
Дополнительная документация от 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. |
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. |
mean
mean(
name='mean'
)
Среднее значение.
mode
mode(
name='mode'
)
Мода.
param_shapes
@classmethod
param_shapes(
sample_shape, name='DistributionParamShapes'
)
Формы параметров, учитывая желаемую форму вызова sample().
Это метод класса, описывающий необходимые ключевые пары «имя-значение» для создания экземпляра данного 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'
)
Функция плотности/массы вероятности.
Дополнительная документация от 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 к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
prob | тензор Tensor формы 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 str к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
quantile | тензор Tensor формы 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 | тензор Tensor с добавленными размерностями sample_shape. |
stddev
stddev(
name='stddev'
)
Стандартное отклонение.
Стандартное отклонение определяется как,
stddev = E[(X - E[X])**2]**0.5
где X — случайная величина, связанная с этим распределением, E обозначает математическое ожидание, и stddev.shape = batch_shape + event_shape.
| Аргументы | |
|---|---|
name | Префикс Python str к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
stddev | Вещественный тензор Tensor с формой, совпадающей с 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 str к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
Tensor формы 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 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/r2.4/api_docs/python/tf/compat/v1/distributions/DirichletMultinomial