tf.contrib.distributions.Binomial
Биномиальное распределение.
Наследуется от: Distribution
tf.contrib.distributions.Binomial(
total_count, logits=None, probs=None, validate_args=False, allow_nan_stats=True,
name='Binomial'
)
Это распределение параметризуется probs, (группой) вероятностями для получения 1 и total_count, количеством испытаний на один выбор из биномиального распределения.
Математические детали
Биномиальное распределение описывает количество 1 в total_count независимых испытаниях, при этом каждое испытание имеет одинаковую вероятность 1, т.е. probs.
Функция вероятности (pmf) равна,
pmf(k; n, p) = p**k (1 - p)**(n - k) / Z Z = k! (n - k)! / n!
где:
-
total_count = n, -
probs = p, -
Z- нормирующая константа, и, -
n!- факториал отn.
Примеры
Создайте одно распределение, соответствующее 5 подбрасываниям монеты.
dist = Binomial(total_count=5., probs=.5)
Создайте одно распределение (используя logits), соответствующее 5 подбрасываниям монеты.
dist = Binomial(total_count=5., logits=0.)
Создайте 3 распределения, при этом третье распределение наиболее вероятно будет иметь успехи.
p = [.2, .3, .8] # n will be broadcast to [4., 4., 4.], to match p. dist = Binomial(total_count=4., probs=p)
Функции распределения могут быть оценены по количеству.
# counts same shape as p. counts = [1., 2, 3] dist.prob(counts) # Shape [3] # p will be broadcast to [[.2, .3, .8], [.2, .3, .8]] to match counts. counts = [[1., 2, 1], [2, 2, 4]] dist.prob(counts) # Shape [2, 3] # p will be broadcast to shape [5, 7, 3] to match counts. counts = [[...]] # Shape [5, 7, 3] dist.prob(counts) # Shape [5, 7, 3]
| Аргументы | |
|---|---|
total_count | Неотрицательное числовое тензор с формой, совместимой с [N1,..., Nm] с m >= 0 и таким же типом данных, как probs или logits. Определяет это как группу N1 x ... x Nm различных биномиальных распределений. Его компоненты должны быть равны целочисленным значениям. |
logits | Числовой тензор, представляющий логарифм отношения шансов положительного события, с формой, совместимой с [N1,..., Nm] m >= 0, и таким же типом данных, как total_count. Каждый элемент представляет логиты вероятности успеха для независимых биномиальных распределений. Только один из logits или probs должен быть передан. |
probs | Положительный числовой тензор с формой, совместимой с [N1,..., Nm] m >= 0, probs in [0, 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 обработанных этим Distribution. |
event_shape | Форма одного образца из одного пакета как TensorShape. Может быть частично определена или неизвестна. |
logits | Логарифм отношения шансов получения 1. |
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.
Размерность пакета - индексы независимых, не одинаковых параметризаций этого распределения.
| Аргументы | |
|---|---|
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'.
| Аргументы | |
|---|---|
name | Python str добавляемое к именам операций, созданных этой функцией. |
| Возвращает | |
|---|---|
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 str, добавляемый к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
cross_entropy | self.dtype Tensor с формой [B1, ..., Bn], представляющей n различные вычисления (шанноновской) взаимной энтропии. |
entropy
entropy(
name='entropy'
)
Шэнноновская энтропия в натах.
event_shape_tensor
event_shape_tensor(
name='event_shape_tensor'
)
Форма одного образца из одного набора как одномерный целочисленный Tensor.
| Аргументы | |
|---|---|
name | имя для операции |
| Возвращаемое значение | |
|---|---|
event_shape | Tensor. |
is_scalar_batch
is_scalar_batch(
name='is_scalar_batch'
)
Указывает, что batch_shape == [].
| Аргументы | |
|---|---|
name | Префикс Python str добавляется к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
is_scalar_batch | bool скалярное значение Tensor. |
is_scalar_event
is_scalar_event(
name='is_scalar_event'
)
Указывает, что event_shape == [].
| Аргументы | |
|---|---|
name | Префикс Python str добавляется к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
is_scalar_event | bool скалярное значение Tensor. |
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 различные вычисления расхождения Кульбака—Лейблера. |
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 | тензор формы sample_shape(x) + self.batch_shape со значениями типа self.dtype. |
log_prob
log_prob(
value, name='log_prob'
)
Логарифм плотности/вероятности.
Дополнительная документация от Binomial:
Для каждого члена набора с количеством value, P[value] — это вероятность того, что после выборки self.total_count извлечений из этого биномиального распределения, количество успехов составит value. Поскольку разные последовательности извлечений могут приводить к одинаковому количеству успехов, вероятность включает комбинаторный коэффициент.
Примечание:valueдолжен быть неотрицательным тензором типаdtypeи его форма должна быть совместима с формамиself.probsиself.total_count.valueдопустимо только если оно меньше или равноself.total_countи его компоненты являются целочисленными.
| Аргументы | |
|---|---|
value | float или double Tensor. |
name | Префикс Python str добавляется к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
log_prob | тензор формы 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 добавляется к именам операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
тензор формы sample_shape(x) + self.batch_shape со значениями типа self.dtype. |
mean
mean(
name='mean'
)
Среднее значение.
mode
mode(
name='mode'
)
Мода.
Дополнительная документация от Binomial:
Обратите внимание, что когда (1 + total_count) * probs целое число, есть две моды. А именно, (1 + total_count) * probs и (1 + total_count) * probs - 1 — обе моды. Здесь возвращается только большая из двух мод.
param_shapes
@classmethod
param_shapes(
sample_shape, name='DistributionParamShapes'
)
Формы параметров, учитывая желаемую форму вызова sample().
Это метод класса, описывающий необходимые аргументы key/value для создания экземпляра данного Distribution, чтобы при вызове sample() для этого экземпляра возвращалась определённая форма.
Подклассы должны переопределять метод класса _param_shapes.
| Аргументы | |
|---|---|
sample_shape | Tensor или список/кортеж Python. Желаемая форма вызова sample(). |
name | Префикс для имен операций. |
| Возвращаемое значение | |
|---|---|
Словарь (dict) сопоставления имени параметра к формам Tensor. |
param_static_shapes
@classmethod
param_static_shapes(
sample_shape
)
param_shapes со статическими (т.е. TensorShape) формами.
Это метод класса, описывающий необходимые аргументы key/value для создания экземпляра данного Distribution, чтобы при вызове sample() для этого экземпляра возвращалась определённая форма. Предполагается, что форма выборки известна статически.
Подклассы должны переопределить метод класса _param_shapes, чтобы возвращать тензоры с постоянными значениями при подаче постоянных значений.
| Аргументы | |
|---|---|
sample_shape | TensorShape или список/кортеж Python. Желаемая форма вызова sample(). |
| Возвращаемое значение | |
|---|---|
Словарь (dict) сопоставления имени параметра к формам TensorShape. |
| Исключения | |
|---|---|
ValueError | если sample_shape является TensorShape и не определён полностью. |
prob
prob(
value, name='prob'
)
Функция плотности/массы вероятностей.
Дополнительная документация из Binomial:
Для каждого элемента набора данных с подсчётами value, P[value] — это вероятность того, что после выборки self.total_count извлечений из этого биномиального распределения, количество успехов равно value. Поскольку различные последовательности извлечений могут приводить к одинаковым подсчётам, вероятность включает комбинаторный коэффициент.
Примечание:valueдолжен быть неотрицательным тензором с типомdtypeи формой, которая может быть переданаself.probsиself.total_count.valueдопустимо только если оно меньше или равноself.total_countи его компоненты равны целым значениям.
| Аргументы | |
|---|---|
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 тензор. Форма генерируемых выборок. |
seed | Целое число Python, 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 | Число с плавающей точкой 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, добавляемая в префикс имён операций, созданных этой функцией. |
| Возвращаемое значение | |
|---|---|
Тензор с формой 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 | Число с плавающей точкой 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/r1.15/api_docs/python/tf/contrib/distributions/Binomial