Spec-Zone.ru › TensorFlow 1.15

tf.contrib.distributions.Geometric

Геометрическое распределение.

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

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

Геометрическое распределение параметризуется p, вероятностью положительного события. Оно представляет вероятность того, что в k + 1 испытаниях Бернулли первые k испытаний завершились неудачей до появления успеха.

Функция вероятности массы (ПМФ) этого распределения:

Математические подробности

pmf(k; p) = (1 - p)**k * p

где:

  • p — вероятность успеха, 0 < p <= 1, и,
  • k — неотрицательное целое число.
Аргументы
logits Вещественное число с плавающей точкой с формой [B1, ..., Bb], где b >= 0 указывает количество пакетных измерений. Каждая запись представляет логарифм вероятности успеха для независимых геометрических распределений и должна находиться в диапазоне (-inf, inf]. Только один из logits или probs должен быть указан.
probs Положительное вещественное число с плавающей точкой с формой [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 Tensors, обрабатываемые этим Distribution.
event_shape Форма одного образца из одного пакета в виде TensorShape.

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

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

В настоящее время это один из статических экземпляров distributions.FULLY_REPARAMETERIZED или distributions.NOT_REPARAMETERIZED.

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 Вещественное число с плавающей точкой с формой [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, добавляемая к именам операций, созданных этой функцией.
Возвращаемые значения
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 с формой [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 тензор Tensor формы sample_shape(x) + self.batch_shape с значениями типа self.dtype.

log_prob

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

log_prob(
    value, name='log_prob'
)

Логарифм плотности/вероятности.

Аргументы
value float или double Tensor.
name строка Python, добавляемая к именам операций, созданных этой функцией.
Возвращаемые значения
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, добавляемая к именам операций, созданных этой функцией.
Возвращаемые значения
тензор 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 желаемая форма вызова sample(), или список/кортеж Python.
name имя для добавления к операциям.
Возвращаемые значения
отображение имени параметра к формам Tensor.

param_static_shapes

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

@classmethod
param_static_shapes(
    sample_shape
)

param_shapes со статическими (т.е. TensorShape) формами.

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

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

Аргументы
sample_shape желаемая форма вызова sample(), или список/кортеж Python.
Возвращаемое значение
dict имени параметра в 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 Целое число Python для генератора псевдослучайных чисел (RNG)
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/r1.15/api_docs/python/tf/contrib/distributions/Geometric

Spec-Zone.ru

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