tf.distributions.Bernoulli
Распределение Бернулли.
Наследуется от: Distribution
tf.distributions.Bernoulli(
logits=None, probs=None, dtype=tf.dtypes.int32, validate_args=False,
allow_nan_stats=True, name='Bernoulli'
)
Распределение Бернулли с параметром probs, т.е. вероятностью 1 результата (по сравнению с 0 результатом).
| Аргументы | |
|---|---|
logits | N-мерный Tensor , представляющий логарифмические шансы 1 события. Каждый элемент в Tensor параметризует независимое распределение Бернулли, где вероятность события равна sigmoid(logits). Должен быть передан только один из logits или probs. |
probs | N-мерный Tensor , представляющий вероятность 1 события. Каждый элемент в Tensor параметризует независимое распределение Бернулли. Должен быть передан только один из logits или probs. |
dtype | Тип событийных выборок. По умолчанию: int32. |
validate_args | Python bool, по умолчанию False. При проверке параметров распределения True на корректность, несмотря на возможную деградацию производительности во время выполнения. При False некорректные входные данные могут безмолвно привести к неверным результатам. |
allow_nan_stats | Python bool, по умолчанию True. При True, статистика (например, среднее значение, мода, дисперсия) использует значение «NaN» для обозначения того, что результат не определен. При False, если один или несколько элементов набора статистических данных не определены, генерируется исключение. |
name | Python str имя, добавляемое как префикс к операциям, созданным этим классом. |
| Исключения | |
|---|---|
ValueError | Если передан и p, и logits, или если ни один из них не передан. |
| Атрибуты | |
|---|---|
allow_nan_stats | Python bool описывающий поведение, когда статистическая величина не определена. Статистические данные возвращают +/- бесконечность, когда это имеет смысл. Например, дисперсия распределения Коши равна бесконечности. Однако иногда статистическая величина не определена, например, если плотность распределения не достигает максимума внутри области определения распределения, мода не определена. Если среднее значение не определено, то по определению дисперсия также не определена. Например, среднее значение для распределения Стьюдента при df = 1 не определено (нет четкого способа сказать, что оно либо + бесконечность, либо - бесконечность), поэтому дисперсия = E[(X - среднее)**2] также не определена. |
batch_shape | Форма одной выборки из одного индекса события в виде TensorShape. Может быть частично определена или неизвестна. Измерения партии — индексы независимых, нетождественных параметризаций этого распределения. |
dtype | DType Tensor , обрабатываемые этим Distribution. |
event_shape | Форма одной выборки из одной партии в виде TensorShape. Может быть частично определена или неизвестна. |
logits | Логарифмические шансы на 1 результат (по сравнению с 0). |
name | Префикс имени ко всем операциям, созданным этим Distribution. |
parameters | Словарь параметров, используемых для инициализации этого Distribution. |
probs | Вероятность 1 результата (по сравнению с 0). |
reparameterization_type | Описание того, как образцы из распределения перепараметризуются. В настоящее время это одна из статических экземпляров |
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 | 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'
)
Ковариация.
Ковариация (возможно) определена только для распределений, которые не являются скалярными событиями.
Например, для n-мерного векторного распределения она вычисляется следующим образом:
Cov[i, j] = Covariance(X_i, X_j) = E[(X_i - E[X_i]) (X_j - E[X_j])]
где Cov — (векторный) матрица, 0 <= (i, j) < k, и E обозначает математическое ожидание.
В альтернативном случае для не векторных многомерных распределений (например, матричнозначных, Вишарта) Covariance возвращает (векторную) матрицу при некотором векторизовании событий, то есть:
Cov[i, j] = Covariance(Vec(X)_i, Vec(X)_j) = [as above]
где Cov — (векторная) матрица, 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'
)
Форма единственного образца из одного набора как 1-мерный int32 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[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 | Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype. |
log_prob
log_prob(
value, name='log_prob'
)
Логарифм плотности/массы вероятности.
| Аргументы | |
|---|---|
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'
)
Мода.
Дополнительная документация из Bernoulli:
Возвращает 1 если prob > 0.5 и 0 в противном случае.
param_shapes
@classmethod
param_shapes(
sample_shape, name='DistributionParamShapes'
)
Формы параметров, учитывая желаемую форму вызова sample().
Это метод класса, описывающий необходимые аргументы ключ/значение для создания данного Distribution, чтобы получить определённую форму для вызова sample() данного экземпляра.
Подклассы должны переопределять метод класса _param_shapes.
| Аргументы | |
|---|---|
sample_shape | Tensor или список/кортеж Python. Желаемая форма вызова sample(). |
name | имя, которое нужно добавить к операциям. |
| Возвращает | |
|---|---|
dict от имени параметра до Tensor форм. |
param_static_shapes
@classmethod
param_static_shapes(
sample_shape
)
param_shapes со статическими (то есть TensorShape) формами.
Это метод класса, описывающий необходимые аргументы ключ/значение для создания данного Distribution, чтобы получить определённую форму для вызова sample() данного экземпляра. Предполагается, что форма образца известна статически.
Подклассы должны переопределять метод класса _param_shapes для возвращения тензоров с постоянными значениями при подаче постоянных значений.
| Аргументы | |
|---|---|
sample_shape | TensorShape или список/кортеж Python. Желаемая форма вызова sample(). |
| Возвращаемое значение | |
|---|---|
dict имени параметра 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 | 0-мерный или 1-мерный int32 Tensor. Форма генерируемых выборок. |
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 | Вещественное число с формой, идентичной 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/Bernoulli