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, т. е. числом испытаний на каждый выбор из многочлена. Оно определено над (пакетом) вектором длины K counts таким образом, что tf.reduce_sum(counts, -1) = total_count. Многочлен идентичен биномиальному распределению, когда K = 2.
Математические подробности
Многочлен — это распределение по K классам, т. е. вектор длины K неотрицательных целых counts = n = [n_0, ..., n_{K-1}].
Функция массы вероятности (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]
| Args | |
|---|---|
total_count | Неотрицательный плавающей точкой тензор с формой, транслируемой до [N1,..., Nm] с m >= 0. Определяет это как пакет N1 x ... x Nm разных распределений многочленов. Его компоненты должны быть равны целочисленным значениям. |
logits | Тензор с плавающей точкой, представляющий ненормализованные логарифмические вероятности положительного события с формой, транслируемой к [N1,..., Nm, K] m >= 0, и тем же типом данных, что и total_count. Определяет это как пакет N1 x ... x Nm различных распределений многочленов K классов. Должен быть передан только один из logits или probs. |
probs | Положительный тензор с плавающей точкой с формой, транслируемой к [N1,..., Nm, K] m >= 0 и тем же типом данных, что и total_count. Определяет это как пакет N1 x ... x Nm различных распределений многочленов K классов. Компоненты probs в последней части его формы должны суммироваться до 1. Должен быть передан только один из logits или probs. |
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. Может быть частично определена или неизвестна. Базовые размеры — это индексы независимых, но не идентичных параметризаций этого распределения. |
dtype | DType из Tensors, обрабатываемых этим Distribution. |
event_shape | Форма одного образца из одной партии как TensorShape. Может быть частично определена или неизвестна. |
logits | Вектор логарифмов координат. |
name | Имя, добавляемое ко всем операциям, созданным этим Distribution. |
parameters | Словарь параметров, используемых для создания этого Distribution. |
probs | Вероятность получения 1 в данной координате. |
reparameterization_type | Описывает, как образцы из распределения перепараметризуются. В настоящее время это одна из статических инстанций |
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]END_OF_DOCUMENT_MARKER
где Cov — (пачка) k' x k' матриц, 0 <= (i, j) < k' = reduce_prod(event_shape), и Vec — некоторая функция, отображающая индексы размерностей событий этого распределения на индексы вектора длины k'.
| Аргументы | |
|---|---|
name | Префикс Python str добавляемый к именам операций, созданных этой функцией. |
| Возвращает | |
|---|---|
covariance | Вещественное Tensor с формой [B1, ..., Bn, k', k'], где первые n измерения — координаты пачки, и k' = reduce_prod(self.event_shape). |
data-text="cross_entropy" id="cross_entropy" tabindex="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.
| Аргументы | |
|---|---|
other | Экземпляр tfp.distributions.Distribution. |
name | Префикс Python str добавляемый к именам операций, созданных этой функцией. |
| Возвращает | |
|---|---|
cross_entropy | Численное self.dtype значение Tensor с формой [B1, ..., Bn] представляющее n различные вычисления (шанноновской) кросс-энтропии. |
data-text="entropy" id="entropy" tabindex="0">entropy
entropy(
name='entropy'
)
Шанноновская энтропия в натах.
data-text="event_shape_tensor" id="event_shape_tensor" tabindex="0">event_shape_tensor
event_shape_tensor(
name='event_shape_tensor'
)
Форма одного образца из одной пачки как 1-мерный целочисленный Tensor.
| Аргументы | |
|---|---|
name | Имя, которое нужно дать операции |
| Возвращает | |
|---|---|
event_shape | Tensor. |
data-text="is_scalar_batch" id="is_scalar_batch" tabindex="0">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" tabindex="0">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" tabindex="0">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 str добавляемый к именам операций, созданных этой функцией. |
| Возвращает | |
|---|---|
kl_divergence | Численное self.dtype значение Tensor с формой [B1, ..., Bn] представляющее n различные вычисления расстояния Кульбака — Лейблера. |
data-text="log_cdf" id="log_cdf" tabindex="0">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" tabindex="0">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.
| Аргументы | |
|---|---|
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" tabindex="0">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'
)
Функция плотности/массы вероятности.
| Аргументы | |
|---|---|
value | float или double Tensor. |
name | строка Python, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
prob | тензор формы sample_shape(x) + self.batch_shape со значениями типа self.dtype. |
quantile
quantile(
value, name='quantile'
)
Функция квантиля. Также известна как "обратная функция распределения" или "функция процентиля".
Для случайной величины X и p in [0, 1], квантиль равна:
quantile(p) := x such that P[X <= x] == p
| Аргументы | |
|---|---|
value | float или double Tensor. |
name | строка Python, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
quantile | тензор формы 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 для семян генератора псевдослучайных чисел (RNG). |
name | имя для операции. |
| Возвращаемое значение | |
|---|---|
samples | тензор с добавленными передними размерностями sample_shape. |
stddev
stddev(
name='stddev'
)
Стандартное отклонение.
Стандартное отклонение определяется как,
stddev = E[(X - E[X])**2]**0.5
где X — случайная величина, связанная с этим распределением, E — математическое ожидание, а stddev.shape = batch_shape + event_shape.
| Аргументы | |
|---|---|
name | строка Python, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
stddev | вещественный тензор с формой, идентичной 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, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
тензор формы 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, добавляемая к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
variance | вещественный тензор с формой, идентичной 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.3/api_docs/python/tf/compat/v1/distributions/Multinomial