Spec-Zone.ru › TensorFlow 1.15

tf.contrib.distributions.StudentTWithAbsDfSoftplusScale

Студентское t с df = floor(abs(df)) и scale = softplus(scale).

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

tf.contrib.distributions.StudentTWithAbsDfSoftplusScale(
    df, loc, scale, validate_args=False, allow_nan_stats=True,
    name='StudentTWithAbsDfSoftplusScale'
)
Атрибуты
allow_nan_stats Python bool описывающий поведение, когда статистика не определена.

Статистики возвращают +/- бесконечность, когда это имеет смысл. Например, дисперсия распределения Коши равна бесконечности. Однако иногда статистика не определена, например, если плотность распределения не достигает максимума в области определения распределения, мода не определена. Если среднее значение не определено, то по определению дисперсия также не определена. Например, среднее значение для распределения Студента при df = 1 не определено (нет явного способа сказать, что оно либо + либо - бесконечность), поэтому дисперсия = E[(X - среднее значение)**2] также не определена.

batch_shape Форма одной выборки из одного индекса события как TensorShape.

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

Размерность пакетной выборки — индексы независимых, нетождественных параметризаций этого распределения.

df Степень свободы в этих распределениях Студента t.
dtype DType Tensor обрабатываемых этим Distribution.
event_shape Форма одной выборки из одного пакета как TensorShape.

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

loc Позиции этих распределений Студента t.
name Префикс имени для всех операций, созданных этим Distribution.
parameters Словарь параметров, используемых для инициализации этого Distribution.
reparameterization_type Описывает, как выборки из распределения перепараметризуются.

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

scale Коэффициенты масштабирования этих распределений Студента t.
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'
)

Форма одной выборки из одного пакета как одномерный целочисленный массив int32 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'
)

Математическое ожидание.

Дополнительная документация из 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().
Возвращает
Словарь из имени параметра в TensorShape формы.
Исключения
ValueError если sample_shape является TensorShape и не полностью определена.

prob

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

prob(
    value, name='prob'
)

Функция плотности/массы вероятности.

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

Spec-Zone.ru

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