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 описывающий поведение при неопределенности статистики. Статистики возвращают +/- бесконечность, когда это имеет смысл. Например, дисперсия распределения Коши равна бесконечности. Однако иногда статистика не определена, например, если pdf распределения не достигает максимума в области определения распределения, мода не определена. Если среднее значение не определено, то по определению дисперсия также не определена. Например, среднее значение для распределения Стьюдента при df = 1 не определено (нет ясного способа сказать, что оно либо + или - бесконечность), поэтому дисперсия = E[(X - среднее)**2] также не определена. |
batch_shape | Форма одного образца из одного индекса события в виде TensorShape. Может быть частично определена или неизвестна. Размерные характеристики партии — индексы независимых, нетождественных параметризаций этого распределения. |
dtype | Размерность DType Tensor обрабатываемых этим Distribution. |
event_shape | Форма одного образца из одной партии в виде TensorShape. Может быть частично определена или неизвестна. |
loc | Параметр распределения для среднего значения. |
name | Имя, добавляемое ко всем операциям, созданным этим Distribution. |
parameters | Словарь параметров, используемых для инициализации этого Distribution. |
reparameterization_type | Описание того, как образцы из распределения перепараметризуются. В настоящее время это одна из статических инстанций |
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 | тензор с формой 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 | Вещественный тензор с формой [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 тензор с формой [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[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 добавленный перед именами операций, созданных этой функцией. |
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 | имя для добавления перед операциями. |
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 | тензор формы 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 целое число seed для генератора случайных чисел (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 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.
| Аргументы | |
|---|---|
name | Python str , добавляемое в имена операций, созданных этой функцией. |
| Возвращает | |
|---|---|
variance | Число с плавающей точкой Tensor с формой, совпадающей с формой 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/versions/r2.9/api_docs/python/tf/compat/v1/distributions/Normal