tf.compat.v1.distributions.Dirichlet
Распределение Дирихле.
Наследуется от: Distribution
tf.compat.v1.distributions.Dirichlet(
concentration,
validate_args=False,
allow_nan_stats=True,
name='Dirichlet'
)
Распределение Дирихле определено над (k-1)-симплексом с помощью положительного вектора длины k concentration (k > 1). Распределение Дирихле совпадает с распределением Бета, когда k = 2.
Математические подробности
Распределение Дирихле — это распределение над открытым (k-1)-симплексом, т.е.
S^{k-1} = { (x_0, ..., x_{k-1}) in R^k : sum_j x_j = 1 and all_j x_j > 0 }.
Плотность вероятности (pdf) равна:
pdf(x; alpha) = prod_j x_j**(alpha_j - 1) / Z Z = prod_j Gamma(alpha_j) / Gamma(sum_j alpha_j)
где:
-
x in S^{k-1}, т.е.,(k-1)-симплекс, -
concentration = alpha = [alpha_0, ..., alpha_{k-1}],alpha_j > 0, -
Z— это нормализующая константа, также известная как многомерная бета-функция, и, -
Gamma— это гамма-функция
concentration представляет собой среднее количество случаев появления классов, т.е.
concentration = alpha = mean * total_concentration
где mean в S^{k-1} и total_concentration — положительное действительное число, представляющее среднее общее количество.
Параметры распределения автоматически векторизуются во всех функциях; см. примеры для получения подробностей.
Выборка из этого распределения перепараметризована (путь, по которому можно вычислять производные). Производные вычисляются с использованием подхода, описанного в (Figurnov и др., 2018).
Примеры
import tensorflow_probability as tfp
tfd = tfp.distributions
# Create a single trivariate Dirichlet, with the 3rd class being three times
# more frequent than the first. I.e., batch_shape=[], event_shape=[3].
alpha = [1., 2, 3]
dist = tfd.Dirichlet(alpha)
dist.sample([4, 5]) # shape: [4, 5, 3]
# x has one sample, one batch, three classes:
x = [.2, .3, .5] # shape: [3]
dist.prob(x) # shape: []
# x has two samples from one batch:
x = [[.1, .4, .5],
[.2, .3, .5]]
dist.prob(x) # shape: [2]
# alpha will be broadcast to shape [5, 7, 3] to match x.
x = [[...]] # shape: [5, 7, 3]
dist.prob(x) # shape: [5, 7]
# Create batch_shape=[2], event_shape=[3]:
alpha = [[1., 2, 3],
[4, 5, 6]] # shape: [2, 3]
dist = tfd.Dirichlet(alpha)
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]
Вычислите градиенты выборок по параметрам:
alpha = tf.constant([1.0, 2.0, 3.0]) dist = tfd.Dirichlet(alpha) samples = dist.sample(5) # Shape [5, 3] loss = tf.reduce_mean(tf.square(samples)) # Arbitrary loss function # Unbiased stochastic gradients of the loss function grads = tf.gradients(loss, alpha)
Ссылки:
Неявные градиенты перепараметризации: Figurnov и др., 2018 (pdf)
| Аргументы | |
|---|---|
concentration | Положительное число с плавающей точкой Tensor , указывающее на среднее количество случаев появления классов; также известен как "альфа". Подразумевает self.dtype, и self.batch_shape, self.event_shape, т.е., если concentration.shape = [N1, N2, ..., Nm, k] , то batch_shape = [N1, N2, ..., Nm] и event_shape = [k]. |
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. Может быть частично определена или неизвестна. Размерность набора индексов в независимые, но не тождественные параметризации этого распределения. |
concentration | Параметр концентрации; ожидаемые подсчеты для этой координаты. |
dtype | DType из Tensors, обрабатываемый этим Distribution. |
event_shape | Форма одной выборки из одного набора как TensorShape. Может быть частично определена или неизвестна. |
name | Имя, добавляемое в префикс к всем операциям, созданным этим Distribution. |
parameters | Словарь параметров, используемых для создания этого Distribution. |
reparameterization_type | Описывает, как выборки из распределения перепараметризуются. В настоящее время это один из статических экземпляров |
total_concentration | Сумма последнего измерения параметра концентрации. |
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 различные вычисления перекрёстной энтропии (Шеннона). |
data-text="entropy" id="entropy">entropy
entropy(
name='entropy'
)
Энтропия Шеннона в натах.
data-text="event_shape_tensor" id="event_shape_tensor">event_shape_tensor
event_shape_tensor(
name='event_shape_tensor'
)
Форма одного образца из одной партии в виде одномерного целочисленного Tensor.
| Аргументы | |
|---|---|
name | имя, присваиваемое операции |
| Возвращает | |
|---|---|
event_shape | Tensor. |
data-text="is_scalar_batch" id="is_scalar_batch">is_scalar_batch
is_scalar_batch(
name='is_scalar_batch'
)
Указывает, что batch_shape == [].
| Аргументы | |
|---|---|
name | Префикс Python str к именам операций, созданных этой функцией. |
| Возвращает | |
|---|---|
is_scalar_batch | bool скаляр Tensor. |
data-text="is_scalar_event" id="is_scalar_event">is_scalar_event
is_scalar_event(
name='is_scalar_event'
)
Указывает, что event_shape == [].
| Аргументы | |
|---|---|
name | Префикс Python str к именам операций, созданных этой функцией. |
| Возвращает | |
|---|---|
is_scalar_event | bool скаляр Tensor. |
data-text="kl_divergence" id="kl_divergence">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 различные вычисления расхождения Куллбека—Лейблера. |
data-text="log_cdf" id="log_cdf">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. |
data-text="log_prob" id="log_prob">log_prob
log_prob(
value, name='log_prob'
)
Логарифм функции плотности/массы вероятности.
Дополнительная документация из Dirichlet:
Примечание:valueдолжен быть неотрицательным тензором с типомself.dtypeи находиться в(self.event_shape() - 1)-симплексе, т. е.,tf.reduce_sum(value, -1) = 1. Он должен иметь форму, совместимую сself.batch_shape() + self.event_shape().
| Аргументы | |
|---|---|
value | float или double Tensor. |
name | Префикс Python str к именам операций, созданных этой функцией. |
| Возвращает | |
|---|---|
log_prob | Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype. |
data-text="log_survival_function" id="log_survival_function">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. |
data-text="mean" id="mean">mean
mean(
name='mean'
)
Среднее значение.
data-text="mode" id="mode">mode
mode(
name='mode'
)
Мода.
Дополнительная документация из Dirichlet:
Примечание: Мода не определена, если какой-либоconcentration <= 1. Еслиself.allow_nan_statsявляетсяTrue,NaNиспользуется для неопределённых мод. Еслиself.allow_nan_statsявляетсяFalse, генерируется исключение при неопределённых моде(ах).
data-text="param_shapes" id="param_shapes">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, чтобы возвращать тензоры с постоянными значениями при подаче постоянных значений.
| Аргументы | |
|---|---|
sample_shape | TensorShape или список/кортеж Python. Желаемая форма вызова sample(). |
| Возвращаемое значение | |
|---|---|
dict имени параметра к TensorShape. |
| Исключения | |
|---|---|
ValueError | если sample_shape является TensorShape и не полностью определен. |
prob
prob(
value, name='prob'
)
Функция плотности/массы вероятности.
Дополнительная документация из Dirichlet:
Примечание:valueдолжен быть ненулевым тензором типаself.dtypeи находиться в(self.event_shape() - 1)-симплексе, т.е.tf.reduce_sum(value, -1) = 1. Он должен иметь форму, совместимую сself.batch_shape() + self.event_shape().
| Аргументы | |
|---|---|
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 | 0D или 1D целочисленный тензор. Форма генерируемых выборок. |
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(). |
© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/compat/v1/distributions/Dirichlet