Spec-Zone.ru › TensorFlow

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(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 имя, добавленное к операциям, созданным этим классом.
Attributes
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 имя, присваиваемое оператору
Returns
batch_shape Tensor.

cdf

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

cdf(
    value, name='cdf'
)

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

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

cdf(x) := P[X <= x]
Args
value float или double Tensor.
name Python-str, добавляемое к именам операций, созданных этой функцией.
Возвращает
cdf a Tensor формы 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'.

Аргументы
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-мерного целочисленного тензора int32 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 a 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 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'
)

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

Аргументы
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().

© 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/Multinomial

Spec-Zone.ru

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