tf.compat.v1.distributions.Bernoulli
Распределение Бернулли.
Наследуется от: Distribution
tf.compat.v1.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'
)
Форма одной выборки из одного индекса события в виде 1-мерного 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'
)
Ковариация.
Ковариация определена (возможно) только для распределений с нескалярными событиями.
Например, для распределения с вектором длины 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'
)
Форма одного образца из одной партии в виде одномерного целого числа типа 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 | тензор формы 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 | тензор формы 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'
)
Мода.
Дополнительная документация из 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 | имя для добавления к операциям. |
| Возвращаемые значения | |
|---|---|
| словарь пар «имя параметра» и «формы параметра». |
param_static_shapes
@classmethod
param_static_shapes(
sample_shape
)
param_shapes со статическими (т.е. TensorShape) формами.
Это метод класса, описывающий какие пары «ключ-значение» необходимы для создания экземпляра данного Distribution, чтобы функция sample() вернула определённую форму. Предполагается, что форма выборки известна статически.
Подклассы должны переопределять метод класса _param_shapes , чтобы возвращать тензоры с постоянными значениями при подаче постоянных значений.
| Аргументы | |
|---|---|
sample_shape | TensorShape или список/кортеж Python. Желаемая форма вызова sample(). |
| Возвращаемые значения | |
|---|---|
| словарь пар «имя параметра» и «форма параметра». |
| Исключения | |
|---|---|
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 | Целое число Python для семян ГСЧ |
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(). |
© 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.4/api_docs/python/tf/compat/v1/distributions/Bernoulli