tf.contrib.distributions.Kumaraswamy
Распределение Кумарасвами.
Наследуется от: TransformedDistribution
tf.contrib.distributions.Kumaraswamy(
concentration1=None, concentration0=None, validate_args=False,
allow_nan_stats=True, name='Kumaraswamy'
)
Распределение Кумарасвами определено на интервале (0, 1) с параметрами concentration1 (также известный как "альфа") и concentration0 (также известный как "бета"). Оно имеет форму, похожую на распределение бета, но является перепараметризуемым.
Математические подробности
Функция плотности вероятности (pdf) равна:
pdf(x; alpha, beta) = alpha * beta * x**(alpha - 1) * (1 - x**alpha)**(beta - 1)
где:
-
concentration1 = alpha, -
concentration0 = beta,
Параметры распределения автоматически транслируются во всех функциях; см. примеры для получения подробностей.
Примеры
# Create a batch of three Kumaraswamy distributions.
alpha = [1, 2, 3]
beta = [1, 2, 3]
dist = Kumaraswamy(alpha, beta)
dist.sample([4, 5]) # Shape [4, 5, 3]
# `x` has three batch entries, each with two samples.
x = [[.1, .4, .5],
[.2, .3, .5]]
# Calculate the probability of each pair of samples under the corresponding
# distribution in `dist`.
dist.prob(x) # Shape [2, 3]
# Create batch_shape=[2, 3] via parameter broadcast: alpha = [[1.], [2]] # Shape [2, 1] beta = [3., 4, 5] # Shape [3] dist = Kumaraswamy(alpha, beta) # alpha broadcast as: [[1., 1, 1,], # [2, 2, 2]] # beta broadcast as: [[3., 4, 5], # [3, 4, 5]] # batch_Shape [2, 3] dist.sample([4, 5]) # Shape [4, 5, 2, 3] x = [.2, .3, .5] # x will be broadcast as [[.2, .3, .5], # [.2, .3, .5]], # thus matching batch_shape [2, 3]. dist.prob(x) # Shape [2, 3]
| Аргументы | |
|---|---|
concentration1 | Положительное число с плавающей точкой Tensor , указывающее среднее количество успехов; также известный как "альфа". Подразумевает self.dtype и self.batch_shape, т.е. concentration1.shape = [N1, N2, ..., Nm] = self.batch_shape. |
concentration0 | Положительное число с плавающей точкой Tensor , указывающее среднее количество неудач; также известный как "бета". В противном случае имеет такие же семантику, как concentration1. |
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. Может быть частично определена или неизвестна. Размерность пакета - это индексы независимых, но не идентичных параметризаций этого распределения. |
bijector | Функция преобразования x => y. |
concentration0 | Параметр концентрации, связанный с исходом 0. |
concentration1 | Параметр концентрации, связанный с исходом 1. |
distribution | Базовое распределение, p(x). |
dtype | Значение DType Tensors, обрабатываемое этим Distribution. |
event_shape | Форма одной выборки из одного пакета в виде TensorShape. Может быть частично определена или неизвестна. |
name | Префикс имени для всех операций, созданных этим Distribution. |
parameters | Словарь параметров, используемых для инициализации этого Distribution. |
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'
)
Ковариация.
Ковариация определена (возможно) только для распределений с нескалярным событием.
Например, для векторного распределения длиной 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[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'
)
Мода.
Дополнительная документация из Kumaraswamy:
Примечание: Мода не определена, когдаconcentration1 <= 1илиconcentration0 <= 1. Еслиself.allow_nan_statsявляетсяTrue,NaNиспользуется для неопределённых мод. Еслиself.allow_nan_statsявляетсяFalse, при возникновении неопределённой моды будет выбрасываться исключение.
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(). |
| Возвращаемое значение | |
|---|---|
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 seed для генератора случайных чисел. |
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/Kumaraswamy