tf.compat.v1.distributions.Categorical

Распределение категорий.

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

tf.compat.v1.distributions.Categorical(
    logits=None, probs=None, dtype=tf.dtypes.int32, validate_args=False,
    allow_nan_stats=True, name='Categorical'
)

Распределение Categorical параметризуется либо вероятностями, либо логарифмами вероятностей набора K классов. Оно определено над целыми числами {0, 1, ..., K}.

Распределение Categorical тесно связано с распределениями OneHotCategorical и Multinomial. Распределение Categorical можно представить как генерирующее выборки в соответствии с argmax{ OneHotCategorical(probs) } , которое само по себе идентично argmax{ Multinomial(probs, total_count=1) }.

Математические детали

Функция вероятности (pmf) имеет вид:

pmf(k; pi) = prod_j pi_j**[k == j]

Возможные ошибки

Количество классов, K, не должно превышать:

• наибольшего целого числа, представимого в self.dtype, т.е., 2**(mantissa_bits+1) (IEEE 754),
• максимального Tensor индекса, т.е., 2**31-1.

Другими словами,

K <= min(2**31-1, {
  tf.float16: 2**11,
  tf.float32: 2**24,
  tf.float64: 2**53 }[param.dtype])

Примечание: Это условие проверяется только при self.validate_args = True.

Примеры

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

dist = Categorical(probs=[0.1, 0.5, 0.4])
n = 1e4
empirical_prob = tf.cast(
    tf.histogram_fixed_width(
      dist.sample(int(n)),
      [0., 2],
      nbins=3),
    dtype=tf.float32) / n
# ==> array([ 0.1005,  0.5037,  0.3958], dtype=float32)

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

dist = Categorical(logits=np.log([0.1, 0.5, 0.4])
n = 1e4
empirical_prob = tf.cast(
    tf.histogram_fixed_width(
      dist.sample(int(n)),
      [0., 2],
      nbins=3),
    dtype=tf.float32) / n
# ==> array([0.1045,  0.5047, 0.3908], dtype=float32)

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

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

# p will be broadcast to [[0.1, 0.4, 0.5], [0.1, 0.4, 0.5]] to match counts.
counts = [1, 0]
dist.prob(counts)  # Shape [2]

# p will be broadcast to shape [3, 5, 7, 3] to match counts.
counts = [[...]] # Shape [5, 7, 3]
dist.prob(counts)  # Shape [5, 7, 3]

Методы

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

cdf

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

cdf(
    value, name='cdf'
)

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

Для случайной величины X, функция кумулятивного распределения cdf равна:

cdf(x) := P[X <= x]

copy

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

copy(
    **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'.

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.

data-text="entropy" id="entropy" tabindex="0">entropy

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

entropy(
    name='entropy'
)

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

data-text="event_shape_tensor" id="event_shape_tensor" tabindex="0">event_shape_tensor

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

event_shape_tensor(
    name='event_shape_tensor'
)

Форма одного образца из одной партии как одномерный целочисленный Tensor.

data-text="is_scalar_batch" id="is_scalar_batch" tabindex="0">is_scalar_batch

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

is_scalar_batch(
    name='is_scalar_batch'
)

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

data-text="is_scalar_event" id="is_scalar_event" tabindex="0">is_scalar_event

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

is_scalar_event(
    name='is_scalar_event'
)

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

data-text="kl_divergence" id="kl_divergence" tabindex="0">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[.] обозначает (энтропию Шеннона).

data-text="log_cdf" id="log_cdf" tabindex="0">log_cdf

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

log_cdf(
    value, name='log_cdf'
)

Логарифм функции кумулятивного распределения.

Для случайной величины X, функция кумулятивного распределения cdf задаётся как:

log_cdf(x) := Log[ P[X <= x] ]

Часто для log_cdf(x) используется численное приближение, которое даёт более точный результат, чем просто взятие логарифма от cdf при x << -1.

data-text="log_prob" id="log_prob" tabindex="0">log_prob

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

log_prob(
    value, name='log_prob'
)

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

data-text="log_survival_function" id="log_survival_function" tabindex="0">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.

data-text="mean" id="mean" tabindex="0">mean

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

mean(
    name='mean'
)

Среднее значение.

data-text="mode" id="mode" tabindex="0">mode

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

mode(
    name='mode'
)

Мода.

data-text="param_shapes" id="param_shapes" tabindex="0">param_shapes

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

@classmethod
param_shapes(
    sample_shape, name='DistributionParamShapes'
)

Формы параметров, учитывая желаемую форму вызова sample().

Это метод класса, который описывает, какие пары "ключ-значение" необходимы для создания экземпляра данного Distribution таким образом, чтобы вызов sample() возвращал определённую форму.

Подклассы должны переопределять метод класса _param_shapes.

data-text="param_static_shapes" id="param_static_shapes" tabindex="0">param_static_shapes

Просмотр исходного кода

@classmethod
param_static_shapes(
    sample_shape
)

param_shapes со статическими (т.е. TensorShape) формами.

Это метод класса, который описывает, какие аргументы ключ/значение необходимы для создания экземпляра данного Distribution, чтобы при вызове sample() этим экземпляром возвращалась определённая форма. Предполагается, что форма выборки известна статически.

Подклассы должны переопределять метод класса _param_shapes, чтобы возвращать тензоры с постоянными значениями при передаче постоянных значений.

prob

Просмотр исходного кода

prob(
    value, name='prob'
)

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

quantile

Просмотр исходного кода

quantile(
    value, name='quantile'
)

Функция квантиля. Также известна как "обратная функция распределения" или "функция процентиля".

Для случайной величины X и p in [0, 1], quantile это:

quantile(p) := x such that P[X <= x] == p

sample

Просмотр исходного кода

sample(
    sample_shape=(), seed=None, name='sample'
)

Генерация выборок указанной формы.

Обратите внимание, что вызов sample() без аргументов сгенерирует одну выборку.

stddev

Просмотр исходного кода

stddev(
    name='stddev'
)

Стандартное отклонение.

Стандартное отклонение определяется как,

stddev = E[(X - E[X])**2]**0.5

где X — случайная величина, связанная с этим распределением, E обозначает математическое ожидание, а stddev.shape = batch_shape + event_shape.

survival_function

Просмотр исходного кода

survival_function(
    value, name='survival_function'
)

Функция выживаемости.

Для случайной величины X, функция выживаемости определяется как:

survival_function(x) = P[X > x]
                     = 1 - P[X <= x]
                     = 1 - cdf(x).

variance

Просмотр исходного кода

variance(
    name='variance'
)

Дисперсия.

Дисперсия определяется как,

Var = E[(X - E[X])**2]

где X — случайная величина, связанная с этим распределением, E обозначает математическое ожидание, а Var.shape = batch_shape + event_shape.