Spec-Zone.ru › TensorFlow 2.3

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)

Аргументы
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 имя, добавляемое к операциям, созданным этим классом.
Возбуждает
TypeError если loc и scale имеют разные типы данных.
Атрибуты
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 Описание того, как образцы из распределения перепараметризуются.

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

scale Коэффициенты масштабирования этих распределений Стьюдента.
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 Префикс, добавляемый к именам операций, созданных этой функцией.
Возвращаемые значения
cross_entropy self.dtype Tensor с формой [B1, ..., Bn], представляющей n различные вычисления перекрёстной энтропии (Шеннона).

entropy

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

entropy(
    name='entropy'
)

Энтропия Шеннона в натах.

event_shape_tensor

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

event_shape_tensor(
    name='event_shape_tensor'
)

Форма одного образца из одной партии в виде 1-мерного целого числа типа int32 Tensor.

Аргументы
name имя, которое следует присвоить операции
Возвращаемые значения
event_shape Tensor.

is_scalar_batch

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

is_scalar_batch(
    name='is_scalar_batch'
)

Указывает, что batch_shape == [].

Аргументы
name Префикс, добавляемый к именам операций, созданных этой функцией.
Возвращаемые значения
is_scalar_batch bool скалярное значение Tensor.

is_scalar_event

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

is_scalar_event(
    name='is_scalar_event'
)

Указывает, что event_shape == [].

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

log_prob

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

log_prob(
    value, name='log_prob'
)

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

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

Дополнительная документация от 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().

© 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/r2.3/api_docs/python/tf/compat/v1/distributions/StudentT

Spec-Zone.ru

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