Spec-Zone.ru › TensorFlow 1.15

tf.contrib.distributions.OneHotCategorical

Распределение OneHotCategorical.

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

tf.contrib.distributions.OneHotCategorical(
    logits=None, probs=None, dtype=tf.dtypes.int32, validate_args=False,
    allow_nan_stats=True, name='OneHotCategorical'
)

Распределение категорий параметризуется логарифмами вероятностей набора классов. Разница между распределениями OneHotCategorical и Categorical заключается в том, что OneHotCategorical — это дискретное распределение над векторами с одним ненулевым битом, а Categorical — дискретное распределение над положительными целыми числами. OneHotCategorical эквивалентно Categorical, за исключением того, что у Categorical event_dim=() , а у OneHotCategorical event_dim=K, где K — количество классов.

Этот класс предоставляет методы для создания индексированных пакетов распределений OneHotCategorical. Если предоставленное logits или probs имеет ранг 2 или выше, для каждого фиксированного набора ведущих измерений последнее измерение представляет собой одно распределение OneHotCategorical. При вызове функций распределения (например, dist.prob(x)), logits и x транслируются в одну и ту же форму (если это возможно). Во всех случаях последнее измерение logits,x представляет собой одиночные распределения OneHotCategorical.

Примеры

Создаёт распределение для 3 классов, где 2-й класс наиболее вероятен для выборки.

p = [0.1, 0.5, 0.4]
dist = OneHotCategorical(probs=p)

Создаёт распределение для 3 классов, где 2-й класс наиболее вероятен для выборки, используя logits.

logits = [-2, 2, 0]
dist = OneHotCategorical(logits=logits)

Создаёт распределение для 3 классов, где 3-й класс наиболее вероятен для выборки.

# counts is a scalar.
p = [0.1, 0.4, 0.5]
dist = OneHotCategorical(probs=p)
dist.prob([0,1,0])  # Shape []

# p will be broadcast to [[0.1, 0.4, 0.5], [0.1, 0.4, 0.5]] to match.
samples = [[0,1,0], [1,0,0]]
dist.prob(samples)  # Shape [2]
Аргументы
logits N-мерный Tensor, N >= 1, представляющий логарифмические вероятности набора распределений Categorical. Первые N - 1 измерения индексируют пакет независимых распределений, а последнее измерение представляет вектор logits для каждого класса. Только один из logits или probs должен быть передан.
probs N-мерный Tensor, N >= 1, представляющий вероятности набора распределений Categorical. Первые N - 1 измерения индексируют пакет независимых распределений, а последнее измерение представляет вектор вероятностей для каждого класса. Только один из logits или probs должен быть передан.
dtype Тип событий выборки (по умолчанию: int32).
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.

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

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

dtype Размер DType из Tensors, обрабатываемых этим Distribution.
event_shape Форма одного образца из одного пакета в виде TensorShape.

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

event_size Скалярный тензор int32: количество классов.
logits Вектор логарифмов вероятностей для каждой координаты.
name Префикс имени для всех операций, созданных этим Distribution.
parameters Словарь параметров, используемых для создания этого Distribution.
probs Вектор вероятностей для каждой координаты.
reparameterization_type Описание того, как образцы из распределения перепараметризуются.

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

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 обозначает математическое ожидание.

В качестве альтернативы, для не векторных, многомерных распределений (например, матричных, Wishart), 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, добавляемая в качестве префикса к именам операций, созданных этой функцией.
Возвращаемое значение
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, добавляемая в качестве префикса к именам операций, созданных этой функцией.
Возвращаемое значение
is_scalar_batch bool скаляр Tensor.

is_scalar_event

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

is_scalar_event(
    name='is_scalar_event'
)

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

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

kl_divergence

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

kl_divergence(
    other, name='kl_divergence'
)

Вычисляет расстояние Кульбака—Лайблера.

Обозначим это распределение (self) как p и распределение other как q. Предполагая, что p, q абсолютно непрерывны относительно опорного распределения r, расстояние KL определяется как:

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

log_prob

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

log_prob(
    value, name='log_prob'
)

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

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

mean

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

mean(
    name='mean'
)

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

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 для имён операций, созданных этой функцией.
Возвращаемое значение
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 0-мерный или 1-мерный int32 Tensor. Форма генерируемых выборок.
seed Целое число Python в качестве семени для генератора случайных чисел.
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 для имён операций, созданных этой функцией.
Возвращаемое значение
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 для имён операций, созданных этой функцией.
Возвращаемое значение
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/OneHotCategorical

Spec-Zone.ru

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