Spec-Zone.ru › TensorFlow

tf.compat.v1.distributions.Normal

Распределение нормального вида с параметрами локализации loc и scale.

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

tf.compat.v1.distributions.Normal(
    loc,
    scale,
    validate_args=False,
    allow_nan_stats=True,
    name='Normal'
)

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

Функция плотности вероятности (pdf) равна,

pdf(x; mu, sigma) = exp(-0.5 (x - mu)**2 / sigma**2) / Z
Z = (2 pi sigma**2)**0.5

где loc = mu — среднее значение, scale = sigma — стандартное отклонение, а Z — константа нормировки.

Распределение нормального вида является членом семейства местоположения-масштаба, то есть его можно построить как,

X ~ Normal(loc=0, scale=1)
Y = loc + scale * X

Примеры

Примеры инициализации одного или нескольких распределений.

import tensorflow_probability as tfp
tfd = tfp.distributions

# Define a single scalar Normal distribution.
dist = tfd.Normal(loc=0., scale=3.)

# Evaluate the cdf at 1, returning a scalar.
dist.cdf(1.)

# Define a batch of two scalar valued Normals.
# The first has mean 1 and standard deviation 11, the second 2 and 22.
dist = tfd.Normal(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.
dist.prob([0, 1.5])

# Get 3 samples, returning a 3 x 2 tensor.
dist.sample([3])

Аргументы транслируются, когда это возможно.

# Define a batch of two scalar valued Normals.
# Both have mean 1, but different standard deviations.
dist = tfd.Normal(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)
Аргументы
loc Числовой тензор с плавающей точкой; среднее значение распределения(ий).
scale Числовой тензор с плавающей точкой; стандартные отклонения распределения(ий). Должны содержать только положительные значения.
validate_args Python bool, по умолчанию False. Когда True параметры распределения проверяются на валидность, несмотря на возможное ухудшение производительности во время выполнения. Когда False недействительные входные данные могут молча привести к неправильным результатам.
allow_nan_stats Python bool, по умолчанию True. Когда True, статистические данные (например, среднее значение, мода, дисперсия) используют значение "NaN", чтобы указать, что результат не определен. Когда False, возникает исключение, если один или несколько статистических данных не определены.
name Python str имя, добавляемое к операциям, созданным этим классом.
Исключения
TypeError если loc и scale имеют разные dtype.
Атрибуты
allow_nan_stats Python bool, описывающий поведение при неопределенном статистическом значении.

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

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

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

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

dtype DType Tensor, обрабатываемых этим 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'
)

Форма одного образца из одного индекса события как 1-мерный 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 тензор формы 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'.

END_OF_DOCUMENT_MARKER
Аргументы
name Python str добавленные в имена операций, созданных этой функцией.
Возвращаемое значение
covariance Вещественное число с плавающей точкой Tensor формой [B1, ..., Bn, k', k'], где первые n измерения — координаты пакетa, а 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-мерного тензора типа 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 определяется как:

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'
)

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

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

Аргументы
name Строка Python, добавляемая в начало имён операций, созданных этой функцией.
Возвращаемое значение
variance Вещественный тензор с формой, идентичной форме 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/api_docs/python/tf/compat/v1/distributions/Normal

Spec-Zone.ru

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