Spec-Zone.ru › TensorFlow 1.15

tf.distributions.Multinomial

Многочленное распределение.

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

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

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

`tf.contrib.distributions.Multinomial`

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

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

tf.compat.v1.distributions.Multinomial

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

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 Tensor обработанный этим Distribution.
event_shape Форма одного выборки из одной группы как TensorShape.

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

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

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

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

Аргументы
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 Число с плавающей точкой self.dtype Tensor с формой [B1, ..., Bn], представляющей n различные вычисления (поперечной) энтропии Шеннона.

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 bool скалярное Tensor.

is_scalar_event

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

is_scalar_event(
    name='is_scalar_event'
)

Указывает, что event_shape == [].

Аргументы
name Строка Python, добавляемая в качестве префикса к именам операций, созданных этой функцией.
Возвращаемое значение
is_scalar_event bool скалярное 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 Вещественное число 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, добавляемая в качестве префикса к именам операций, созданных этой функцией.
Возвращаемое значение
logcdf массив Tensor с формой sample_shape(x) + self.batch_shape и значениями типа self.dtype.

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, добавляемая в качестве префикса к именам операций, созданных этой функцией.
Возвращаемое значение
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, добавляемая в качестве префикса к именам операций, созданных этой функцией.
Возвращает
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:

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 Целочисленный начальный семенной элемент для ГПСЧ
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/r1.15/api_docs/python/tf/distributions/Multinomial

Spec-Zone.ru

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