Spec-Zone.ru › TensorFlow 2.3

tf.compat.v1.distributions.Uniform

Равномерное распределение с параметрами low и high.

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

tf.compat.v1.distributions.Uniform(
    low=0.0, high=1.0, validate_args=False, allow_nan_stats=True, name='Uniform'
)

Математические подробности

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

pdf(x; a, b) = I[a <= x < b] / Z
Z = b - a

где

  • low = a,
  • high = b,
  • Z — нормирующая константа, и
  • I[predicate] — функция индикатора для predicate.

Параметры low и high должны быть сформированы таким образом, чтобы поддерживать векторизацию (например, high - low — это допустимая операция).

Примеры

# Without broadcasting:
u1 = Uniform(low=3.0, high=4.0)  # a single uniform distribution [3, 4]
u2 = Uniform(low=[1.0, 2.0],
             high=[3.0, 4.0])  # 2 distributions [1, 3], [2, 4]
u3 = Uniform(low=[[1.0, 2.0],
                  [3.0, 4.0]],
             high=[[1.5, 2.5],
                   [3.5, 4.5]])  # 4 distributions
# With broadcasting:
u1 = Uniform(low=3.0, high=[5.0, 6.0, 7.0])  # 3 distributions
Args
low Плавающая точка тензор, нижняя граница интервала вывода. Должен иметь low < high.
high Плавающая точка тензор, верхняя граница интервала вывода. Должен иметь low < high.
validate_args Python bool, по умолчанию False. При True проверяются параметры распределения, несмотря на возможные снижения производительности во время выполнения. При False недействительные входные данные могут молча привести к неверным результатам.
allow_nan_stats Python bool, по умолчанию True. При True, статистика (например, среднее значение, мода, дисперсия) используют значение "NaN" для обозначения того, что результат неопределён. При False, возникает исключение, если один или несколько из членов пакетной статистики неопределены.
name Python str имя, добавленное к операциям, созданным этим классом.
Raises
InvalidArgumentError если low >= high и validate_args=False.
Атрибуты
allow_nan_stats Python bool описывающий поведение при неопределённом значении статистики.

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

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

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

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

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

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

high Верхняя граница интервала вывода.
low Нижняя граница интервала вывода.
name Имя, добавленное к всем операциям, созданным этим Distribution.
parameters Словарь параметров, используемых для инициализации этого Distribution.
reparameterization_type Описывает, как образцы из распределения перепараметризуются.

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

validate_args Python bool указывает, возможно ли включить дорогостоящие проверки.

Методы

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

Args
name имя для присвоения операции
Возвращает
batch_shape Tensor.

cdf

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

cdf(
    value, name='cdf'
)

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

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

cdf(x) := P[X <= x]
Args
value float или double Tensor.
name Python str префикс к именам операций, созданных этой функцией.
Возвращает
cdf тензор размера sample_shape(x) + self.batch_shape с типами self.dtype.

copy

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

copy(
    **override_parameters_kwargs
)

Создаёт глубокую копию распределения.

Примечание: распределение копии может по-прежнему зависеть от исходных аргументов инициализации.
Args
**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' вектора.

Args
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.

Args
other Экземпляр tfp.distributions.Distribution.
name Python str префикс к именам операций, созданных этой функцией.
Возвращает
cross_entropy Плавающая точка тензор с размером [B1, ..., Bn] , представляющий различные вычисления (энтропии Шеннона) перекрёстной энтропии.

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

range

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

range(
    name='range'
)

high - low.

sample

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

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

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

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

Аргументы
sample_shape 0D или 1D int32 Tensor. Форма генерируемых выборок.
seed Целое число Python для семян ГПСЧ
name Имя для операции.
Возвращаемое значение
samples Tensor с добавленными измерениями 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().

© 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/r2.3/api_docs/python/tf/compat/v1/distributions/Uniform

Spec-Zone.ru

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