tf.compat.v1.distributions.StudentT
Распределение Стьюдента.
Наследуется от: Distribution
tf.compat.v1.distributions.StudentT(
df,
loc,
scale,
validate_args=False,
allow_nan_stats=True,
name='StudentT'
)
Это распределение имеет параметры: число степеней свободы df, положение loc, и scale.
Математические детали
Функция плотности вероятности (pdf) равна,
pdf(x; df, mu, sigma) = (1 + y**2 / df)**(-0.5 (df + 1)) / Z where, y = (x - mu) / sigma Z = abs(sigma) sqrt(df pi) Gamma(0.5 df) / Gamma(0.5 (df + 1))
где:
-
loc = mu, -
scale = sigma, и, -
Zявляется нормирующей константой, и, -
Gammaявляется функцией Гамма.
Распределение Стьюдента является членом семейства местоположения-масштаба, т.е. его можно построить как,
X ~ StudentT(df, loc=0, scale=1) Y = loc + scale * X
Обратите внимание, что scale имеет семантику, более похожую на стандартное отклонение, чем на дисперсию. Однако это не фактическое стандартное отклонение; стандартное отклонение распределения Стьюдента равно scale sqrt(df / (df - 2)) при df > 2.
Образцы этого распределения перепараметризованы (путевая дифференцируемость). Производные вычисляются с помощью подхода, описанного в (Figurnov et al., 2018).
Примеры
Примеры инициализации одного или нескольких распределений.
import tensorflow_probability as tfp tfd = tfp.distributions # Define a single scalar Student t distribution. single_dist = tfd.StudentT(df=3) # Evaluate the pdf at 1, returning a scalar Tensor. single_dist.prob(1.) # Define a batch of two scalar valued Student t's. # The first has degrees of freedom 2, mean 1, and scale 11. # The second 3, 2 and 22. multi_dist = tfd.StudentT(df=[2, 3], loc=[1, 2.], scale=[11, 22.]) # Evaluate the pdf of the first distribution on 0, and the second on 1.5, # returning a length two tensor. multi_dist.prob([0, 1.5]) # Get 3 samples, returning a 3 x 2 tensor. multi_dist.sample(3)
Аргументы транслируются, когда это возможно.
# Define a batch of two Student's t distributions. # Both have df 2 and mean 1, but different scales. dist = tfd.StudentT(df=2, loc=1, scale=[11, 22.]) # Evaluate the pdf of both distributions on the same point, 3.0, # returning a length 2 tensor. dist.prob(3.0)
Вычислите градиенты выборок относительно параметров:
df = tf.constant(2.0) loc = tf.constant(2.0) scale = tf.constant(11.0) dist = tfd.StudentT(df=df, loc=loc, scale=scale) samples = dist.sample(5) # Shape [5] loss = tf.reduce_mean(tf.square(samples)) # Arbitrary loss function # Unbiased stochastic gradients of the loss function grads = tf.gradients(loss, [df, loc, scale])
Ссылки:
Неявные градиенты перепараметризации: Figurnov et al., 2018 (pdf)
| Args | |
|---|---|
df | Числа с плавающей точкой Tensor. Число степеней свободы распределения(ий). df должны содержать только положительные значения. |
loc | Числа с плавающей точкой Tensor. Среднее(ие) распределения(ий). |
scale | Числа с плавающей точкой Tensor. Коэффициент масштабирования(ов) для распределения(ий). Обратите внимание, что scale технически не является стандартным отклонением этого распределения, но имеет семантику, более похожую на стандартное отклонение, чем на дисперсию. |
validate_args | Python bool, по умолчанию False. Когда True проверяются параметры распределения на корректность, несмотря на возможную деградацию производительности во время выполнения. Если False, некорректные входные данные могут в молчаливом режиме привести к неверным результатам. |
allow_nan_stats | Python bool, по умолчанию True. Когда True, статистика (например, среднее значение, мода, дисперсия) использует значение "NaN", чтобы указать, что результат не определен. Если False, возникает исключение, если один или несколько членов пакетной статистики не определены. |
name | Python str имя, добавляемое в качестве префикса к операциям, созданным этим классом. |
| Raises | |
|---|---|
TypeError | если loc и scale имеют разные типы данных. |
| Attributes | |
|---|---|
allow_nan_stats | Python bool описывающий поведение, когда статистическая величина не определена. Статистические величины возвращают +/- бесконечность, когда это имеет смысл. Например, дисперсия распределения Коши равна бесконечности. Однако иногда статистическая величина не определена, например, если функция плотности вероятности распределения не достигает максимума в пределах области определения распределения, мода не определена. Если среднее значение не определено, то по определению дисперсия также не определена. Например, среднее значение для распределения Стьюдента при df = 1 не определено (нет ясного способа сказать, что это либо + или - бесконечность), поэтому дисперсия = E[(X - среднее значение)**2] также не определена. |
batch_shape | Форма одного образца из одного индекса события как TensorShape. Может быть частично определена или неизвестна. Размер пакетных данных — индексы независимых, нетождественных параметризаций этого распределения. |
df | Число степеней свободы в этих распределениях Стьюдента. |
dtype | DType Tensors, обрабатываемые этим Distribution. |
event_shape | Форма одного образца из одного пакета как TensorShape. Может быть частично определена или неизвестна. |
loc | Положения этих распределений Стьюдента. |
name | Имя, добавляемое в качестве префикса ко всем операциям, созданным этим Distribution. |
parameters | Словарь параметров, используемых для инициализации этого Distribution. |
reparameterization_type | Описывает, как образцы из распределения перепараметризованы. В настоящее время это один из статических экземпляров |
scale | Коэффициенты масштабирования этих распределений Стьюдента. |
validate_args | Python bool указывающий, что, возможно, дорогостоящие проверки включены. |
Методы
batch_shape_tensor
batch_shape_tensor(
name='batch_shape_tensor'
)
Форма одного образца из одного индекса события как одномерный Tensor.
Размер пакетных данных — индексы независимых, нетождественных параметризаций этого распределения.
| Args | |
|---|---|
name | имя для операции |
| Returns | |
|---|---|
batch_shape | Tensor. |
cdf
cdf(
value, name='cdf'
)
Функция кумулятивного распределения.
Для случайной величины X, функция кумулятивного распределения cdf равна:
cdf(x) := P[X <= x]
| Args | |
|---|---|
value | float или double Tensor. |
name | Python str префикс для имен операций, созданных этой функцией. |
| Returns | |
|---|---|
cdf | тензор с формой sample_shape(x) + self.batch_shape и значениями типа self.dtype. |
copy
copy(
**override_parameters_kwargs
)
Создает глубокую копию распределения.
Примечание: распределение копии может по-прежнему зависеть от исходных аргументов инициализации.
| Args | |
|---|---|
**override_parameters_kwargs | Словарь строк/значений аргументов инициализации, которые нужно переопределить новыми значениями. |
| Returns | |
|---|---|
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'.
| Args | |
|---|---|
name | Python str префикс для имен операций, созданных этой функцией. |
| Returns | |
|---|---|
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'
)
Математическое ожидание.
Дополнительная документация от StudentT.
Математическое ожидание распределения Стьюдента равно loc, если df > 1, в противном случае оно равно NaN. Если self.allow_nan_stats=True, то вместо возвращения NaN будет выброшено исключение.
mode
mode(
name='mode'
)
Мода.
param_shapes
@classmethod
param_shapes(
sample_shape, name='DistributionParamShapes'
)
Формы параметров, заданных желаемой формой вызова sample().
Это метод класса, который описывает, какие аргументы ключ/значение требуются для создания данного Distribution, чтобы в вызове sample() данного экземпляра возвращалась определённая форма.
Подклассы должны переопределить метод класса _param_shapes.
| Аргументы | |
|---|---|
sample_shape | Tensor или список/кортеж Python. Желаемая форма вызова sample(). |
name | Имя для добавления префикса к операциям. |
| Возвращает | |
|---|---|
Словарь имени параметра к формам Tensor. |
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 | a Tensor формы sample_shape(x) + self.batch_shape со значениями типа self.dtype. |
quantile
quantile(
value, name='quantile'
)
Функция квантиля. Также известна как "обратная функция распределения" или "функция процентиля".
Для случайной величины X и p in [0, 1], квантиль:
quantile(p) := x such that P[X <= x] == p
| Аргументы | |
|---|---|
value | float или double Tensor. |
name | Префикс Python str для имён операций, созданных этой функцией. |
| Возвращает | |
|---|---|
quantile | a 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 | a 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.
Дополнительная документация из StudentT:
Дисперсия для распределения Стьюдента равна
df / (df - 2), when df > 2 infinity, when 1 < df <= 2 NaN, when df <= 1
| Аргументы | |
|---|---|
name | Префикс Python str для имён операций, созданных этой функцией. |
| Возвращает | |
|---|---|
variance | Число с плавающей запятой Tensor с формой, совпадающей с 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/StudentT