Spec-Zone.ru › TensorFlow 1.15

tf.contrib.distributions.NegativeBinomial

Распределение отрицательного биномиального.

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

tf.contrib.distributions.NegativeBinomial(
    total_count, logits=None, probs=None, validate_args=False, allow_nan_stats=True,
    name='NegativeBinomial'
)

Распределение отрицательного биномиального связано с экспериментом по последовательному проведению биномиальных испытаний. Учитывая биномиальное испытание с вероятностью p успеха, распределение отрицательного биномиального представляет собой распределение количества успехов s , которые происходят до тех пор, пока мы не наблюдаем f неудач.

Функция вероятности (pmf) равна:

pmf(s; f, p) = p**s (1 - p)**f / Z
Z = s! (f - 1)! / (s + f - 1)!

где:

  • total_count = f,
  • probs = p,
  • Z является нормирующей константой, и,
  • n! — это факториал n.
Аргументы
total_count Неотрицательное число с плавающей запятой Tensor с формой, совместимой с [B1,..., Bb] с b >= 0 и тем же типом данных, что и probs или logits. Определяет это как пакет из N1 x ... x Nm различных распределений отрицательного биномиального. На практике это представляет собой количество отрицательных биномиальных испытаний для остановки (количество неудач), но это все еще является допустимым распределением, когда total_count — это не целое число.
logits Число с плавающей запятой Tensor с формой, совместимой с [B1, ..., Bb] , где b >= 0 указывает количество размерностей пакета. Каждая запись представляет собой логарифмы вероятности успеха для независимых распределений отрицательного биномиального и должна находиться в открытом интервале (-inf, inf). Должен быть указан только один из logits или probs.
probs Положительное число с плавающей запятой Tensor с формой, совместимой с [B1, ..., Bb] , где b >= 0 указывает количество размерностей пакета. Каждая запись представляет собой вероятность успеха для независимых распределений отрицательного биномиального и должна находиться в открытом интервале (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 Tensor обрабатываемых этим Distribution.
event_shape Форма одного образца из одного пакета как TensorShape.

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

logits Логарифм шансов на 1 исход (по сравнению с 0).
name Имя, добавляемое в качестве префикса ко всем операциям, созданным этим Distribution.
parameters Словарь параметров, используемых для создания этого Distribution.
probs Вероятность 1 исхода (по сравнению с 0).
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.

Размерности пакета являются индексами для независимых, неидентичных параметризаций этого распределения.

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

Форма единственного образца из отдельной группы как 1-мерный целочисленный тип 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'
)

Мода.

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) формами.

Это метод класса, описывающий необходимые аргументы key/value для создания экземпляра данного Distribution, чтобы при вызове sample() данным экземпляром возвращалась определённая форма. Предполагается, что форма образца известна статически.

Подклассы должны переопределять метод класса _param_shapes, чтобы возвращать тензоры с постоянными значениями при подаче постоянных значений.

class="responsive fixed orange">
Аргументы
sample_shape TensorShape или список/кортеж Python. Желаемая форма вызова sample().
class="responsive fixed orange">
Возвращаемое значение
dict от имени параметра до TensorShape.
class="responsive fixed orange">
Возможные исключения
ValueError если sample_shape является TensorShape и не полностью определён.

prob

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

prob(
    value, name='prob'
)

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

class="responsive fixed orange">
Аргументы
value float или double Tensor.
name Префикс Python str для имён операций, созданных этой функцией.
class="responsive fixed orange">
Возвращаемое значение
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
class="responsive fixed orange">
Аргументы
value float или double Tensor.
name Префикс Python str для имён операций, созданных этой функцией.
class="responsive fixed orange">
Возвращаемое значение
quantile Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype.

sample

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

sample(
    sample_shape=(), seed=None, name='sample'
)

Генерирует образцы указанной формы.

Обратите внимание, что вызов sample() без аргументов сгенерирует один образец.

class="responsive fixed orange">
Аргументы
sample_shape 0D или 1D int32 Tensor. Форма генерируемых образцов.
seed Целое число Python для инициализации генератора случайных чисел.
name Имя операции.
class="responsive fixed orange">
Возвращаемое значение
samples Tensor с добавленными перед измерениями sample_shape.

stddev

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

stddev(
    name='stddev'
)

Среднеквадратическое отклонение.

Среднеквадратическое отклонение определяется как,

stddev = E[(X - E[X])**2]**0.5

где X — случайная величина, связанная с этим распределением, E обозначает математическое ожидание, а stddev.shape = batch_shape + event_shape.

class="responsive fixed orange">
Аргументы
name Префикс Python str для имён операций, созданных этой функцией.
class="responsive fixed orange">
Возвращаемое значение
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).
class="responsive fixed orange">
Аргументы
value float или double Tensor.
name Префикс Python str для имён операций, созданных этой функцией.
class="responsive fixed orange">
Возвращаемое значение
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.

class="responsive fixed orange">
Аргументы
name Префикс Python str для имён операций, созданных этой функцией.
class="responsive fixed orange">
Возвращаемое значение
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/NegativeBinomial

Spec-Zone.ru

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