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]
| Аргументы | |
|---|---|
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 | Описывает, как выборки из распределения перепараметризуются. В настоящее время это один из статических экземпляров |
total_concentration | Сумма последнего измерения параметра концентрации. |
total_count | Количество испытаний, используемых для построения выборки. |
validate_args | Python bool, указывающий, что возможно включены дорогостоящие проверки. |
Методы
batch_shape_tensor
batch_shape_tensor(
name='batch_shape_tensor'
)
Форма одиночной выборки из одного индекса события в виде 1-мерного 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 | массив формы 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'.
Дополнительная документация от 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, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
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, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
cross_entropy | Числовое значение с плавающей точкой Tensor формы [B1, ..., Bn], представляющее различные вычисления (энтропии Шеннона) перекрёстной энтропии. |
entropy
entropy(
name='entropy'
)
Энтропия Шеннона в натах.
event_shape_tensor
event_shape_tensor(
name='event_shape_tensor'
)
Форма одного образца из одной группы в виде 1-мерного целочисленного Tensor.
| Аргументы | |
|---|---|
name | Имя, которое нужно дать операции |
| Возвращаемое значение | |
|---|---|
event_shape | Tensor. |
is_scalar_batch
is_scalar_batch(
name='is_scalar_batch'
)
Указывает, что batch_shape == [].
| Аргументы | |
|---|---|
name | Строка Python, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
is_scalar_batch | Скалярное число с плавающей точкой Tensor. |
is_scalar_event
is_scalar_event(
name='is_scalar_event'
)
Указывает, что event_shape == [].
| Аргументы | |
|---|---|
name | Строка Python, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
is_scalar_event | Скалярное число с плавающей точкой Tensor. |
kl_divergence
kl_divergence(
other, name='kl_divergence'
)
Вычисление расхождения Кульбака — Лейблера.
Обозначим это распределение (self) как p, а распределение other — как q. Предполагая, что p, q абсолютно непрерывны относительно меры отсчёта r, расхождение Кульбака — Лейблера определяется как:
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, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
kl_divergence | Числовое значение с плавающей точкой Tensor формы [B1, ..., Bn], представляющее различные вычисления расхождения Кульбака — Лейблера. |
log_cdf
log_cdf(
value, name='log_cdf'
)
Логарифм функции кумулятивного распределения.
Для случайной величины X функция кумулятивного распределения cdf имеет вид:
log_cdf(x) := Log[ P[X <= x] ]
Часто для log_cdf(x) можно использовать численный приближение, которое даст более точный ответ, чем просто взятие логарифма от cdf, когда x << -1.
| Аргументы | |
|---|---|
value | Значение или массив значений double Tensor. |
name | Строка Python, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
logcdf | массив формы 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.
| Аргументы | |
|---|---|
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 | Имя для добавления префикса к операциям. |
| Возвращаемое значение | |
|---|---|
Словарь имён параметров к формам 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'
)
Функция плотности/массы вероятности.
Дополнительная документация из 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 | Целое число Python для семени генератора случайных чисел |
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(). |
© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/api_docs/python/tf/compat/v1/distributions/DirichletMultinomial