<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/pixel_cnn.py#L37-L619) |

The Pixel CNN++ distribution.

Inherits From: [`Distribution`](https://www.tensorflow.org/probability/api_docs/python/tfp/distributions/Distribution)

    tfp.distributions.PixelCNN(
        image_shape,
        conditional_shape=None,
        num_resnet=5,
        num_hierarchies=3,
        num_filters=160,
        num_logistic_mix=10,
        receptive_field_dims=(3, 3),
        dropout_p=0.5,
        resnet_activation='concat_elu',
        use_weight_norm=True,
        use_data_init=True,
        high=255,
        low=0,
        dtype=tf.float32,
        name='PixelCNN'
    )

Pixel CNN++ \[(Salimans et al., 2017)\]\[1\] models a distribution over image
data, parameterized by a neural network. It builds on Pixel CNN and
Conditional Pixel CNN, as originally proposed by \[(van den Oord et al.,
2016)\]\[2, 3\]. The model expresses the joint distribution over pixels as
the product of conditional distributions:
`p(x|h) = prod{ p(x[i] | x[0:i], h) : i=0, ..., d }`,
in which `p(x[i] | x[0:i], h) : i=0, ..., d` is the
probability of the `i`-th pixel conditional on the pixels that preceded it in
raster order (color channels in RGB order, then left to right, then top to
bottom). `h` is optional additional data on which to condition the image
distribution, such as class labels or VAE embeddings. The Pixel CNN++
network enforces the dependency structure among pixels by applying a mask to
the kernels of the convolutional layers that ensures that the values for each
pixel depend only on other pixels up and to the left (see
`tfd.PixelCnnNetwork`).

Pixel values are modeled with a mixture of quantized logistic distributions,
which can take on a set of distinct integer values (e.g. between 0 and 255
for an 8-bit image).

Color intensity `v` of each pixel is modeled as:

`v ~ sum{q[i] * quantized_logistic(loc[i], scale[i]) : i = 0, ..., k }`,

in which `k` is the number of mixture components and the `q[i]` are the
Categorical probabilities over the components.

#### Sampling

Pixels are sampled one at a time, in raster order. This enforces the
autoregressive dependency structure, in which the sample of pixel `i` is
conditioned on the samples of pixels `1, ..., i-1`. A single color image is
sampled as follows:

    samples = random_uniform([image_height, image_width, image_channels])
    for i in image_height:
      for j in image_width:
        component_logits, locs, scales, coeffs = pixel_cnn_network(samples)
        components = Categorical(component_logits).sample()
        locs = gather(locs, components)
        scales = gather(scales, components)

        coef_count = 0
        channel_samples = []
        for k in image_channels:
          loc = locs[k]
          for m in range(k):
            loc += channel_samples[m] * coeffs[coef_count]
            coef_count += 1
          channel_samp = Logistic(loc, scales[k]).sample()
          channel_samples.append(channel_samp)
        samples[i, j, :] = tf.stack(channel_samples, axis=-1)
    samples = round(samples)

#### Examples


    # Build a small Pixel CNN++ model to train on MNIST.

    import tensorflow as tf
    import tensorflow_datasets as tfds
    import tensorflow_probability as tfp

    tfd = tfp.distributions
    tfk = tf_keras
    tfkl = tf_keras.layers

    # Load MNIST from tensorflow_datasets
    data = tfds.load('mnist')
    train_data, test_data = data['train'], data['test']

    def image_preprocess(x):
      x['image'] = tf.cast(x['image'], tf.float32)
      return (x['image'],)  # (input, output) of the model

    batch_size = 16
    train_it = train_data.map(image_preprocess).batch(batch_size).shuffle(1000)

    image_shape = (28, 28, 1)
    # Define a Pixel CNN network
    dist = tfd.PixelCNN(
        image_shape=image_shape,
        num_resnet=1,
        num_hierarchies=2,
        num_filters=32,
        num_logistic_mix=5,
        dropout_p=.3,
    )

    # Define the model input
    image_input = tfkl.Input(shape=image_shape)

    # Define the log likelihood for the loss fn
    log_prob = dist.log_prob(image_input)

    # Define the model
    model = tfk.Model(inputs=image_input, outputs=log_prob)
    model.add_loss(-tf.reduce_mean(log_prob))

    # Compile and train the model
    model.compile(
        optimizer=tfk.optimizers.Adam(.001),
        metrics=[])

    model.fit(train_it, epochs=10, verbose=True)

    # sample five images from the trained model
    samples = dist.sample(5)

To train a class-conditional model:


    data = tfds.load('mnist')
    train_data, test_data = data['train'], data['test']

    def image_preprocess(x):
      x['image'] = tf.cast(x['image'], tf.float32)
      # return model (inputs, outputs): inputs are (image, label) and there are no
      # outputs
      return ((x['image'], x['label']),)

    batch_size = 16
    train_ds = train_data.map(image_preprocess).batch(batch_size).shuffle(1000)
    optimizer = tfk.optimizers.Adam()

    image_shape = (28, 28, 1)
    label_shape = ()
    dist = tfd.PixelCNN(
        image_shape=image_shape,
        conditional_shape=label_shape,
        num_resnet=1,
        num_hierarchies=2,
        num_filters=32,
        num_logistic_mix=5,
        dropout_p=.3,
    )

    image_input = tfkl.Input(shape=image_shape)
    label_input = tfkl.Input(shape=label_shape)

    log_prob = dist.log_prob(image_input, conditional_input=label_input)

    class_cond_model = tfk.Model(
        inputs=[image_input, label_input], outputs=log_prob)
    class_cond_model.add_loss(-tf.reduce_mean(log_prob))
    class_cond_model.compile(
        optimizer=tfk.optimizers.Adam(),
        metrics=[])
    class_cond_model.fit(train_ds, epochs=10)

    # Take 10 samples of the digit '5'
    samples = dist.sample(10, conditional_input=5.)

    # Take 4 samples each of the digits '1', '2', '3'.
    # Note that when a batch of conditional input is passed, the sample shape
    # (the first argument of `dist.sample`) must have its last dimension(s) equal
    # the batch shape of the conditional input (here, (3,)).
    samples = dist.sample((4, 3), conditional_input=[1., 2., 3.])

> [!NOTE]
> **Note:** PixelCNN may also be trained using tfp.layers.DistributionLambda; however, as of this writing, that method is much slower and has the disadvantage of calling `sample()` upon construction, which causes the `PixelCnnNetwork` to be initialized with random data (if data-dependent initialization is used).

#### References

\[1\]: Tim Salimans, Andrej Karpathy, Xi Chen, and Diederik P. Kingma.
PixelCNN++: Improving the PixelCNN with Discretized Logistic Mixture
Likelihood and Other Modifications. In *International Conference on
Learning Representations* , 2017.
<https://pdfs.semanticscholar.org/9e90/6792f67cbdda7b7777b69284a81044857656.pdf>
Additional details at <https://github.com/openai/pixel-cnn>

\[2\]: Aaron van den Oord, Nal Kalchbrenner, Oriol Vinyals, Lasse Espeholt,
Alex Graves, and Koray Kavukcuoglu. Conditional Image Generation with
PixelCNN Decoders. In *Neural Information Processing Systems* , 2016.
<https://arxiv.org/abs/1606.05328>

\[3\]: Aaron van den Oord, Nal Kalchbrenner, and Koray Kavukcuoglu. Pixel
Recurrent Neural Networks. In *International Conference on Machine
Learning* , 2016. <https://arxiv.org/pdf/1601.06759.pdf>

<br />

<br />

<br />

| ## Args ||
|---|---|
| `image_shape` | 3D `TensorShape` or tuple for the `[height, width, channels]` dimensions of the image. |
| `conditional_shape` | `TensorShape` or tuple for the shape of the conditional input, or `None` if there is no conditional input. |
| `num_resnet` | `int`, the number of layers (shown in Figure 2 of \[2\]) within each highest-level block of Figure 2 of \[1\]. |
| `num_hierarchies` | `int`, the number of hightest-level blocks (separated by expansions/contractions of dimensions in Figure 2 of \[1\].) |
| `num_filters` | `int`, the number of convolutional filters. |
| `num_logistic_mix` | `int`, number of components in the logistic mixture distribution. |
| `receptive_field_dims` | `tuple`, height and width in pixels of the receptive field of the convolutional layers above and to the left of a given pixel. The width (second element of the tuple) should be odd. Figure 1 (middle) of \[2\] shows a receptive field of (3, 5) (the row containing the current pixel is included in the height). The default of (3, 3) was used to produce the results in \[1\]. |
| `dropout_p` | `float`, the dropout probability. Should be between 0 and 1. |
| `resnet_activation` | `string`, the type of activation to use in the resnet blocks. May be 'concat_elu', 'elu', or 'relu'. |
| `use_weight_norm` | `bool`, if `True` then use weight normalization (works only in Eager mode). |
| `use_data_init` | `bool`, if `True` then use data-dependent initialization (has no effect if `use_weight_norm` is `False`). |
| `high` | `int`, the maximum value of the input data (255 for an 8-bit image). |
| `low` | `int`, the minimum value of the input data. |
| `dtype` | Data type of the `Distribution`. |
| `name` | `string`, the name of the `Distribution`. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `allow_nan_stats` | Python `bool` describing behavior when a stat is undefined. <br /> Stats return +/- infinity when it makes sense. E.g., the variance of a Cauchy distribution is infinity. However, sometimes the statistic is undefined, e.g., if a distribution's pdf does not achieve a maximum within the support of the distribution, the mode is undefined. If the mean is undefined, then by definition the variance is undefined. E.g. the mean for Student's T for df = 1 is undefined (no clear way to say it is either + or - infinity), so the variance = E\[(X - mean)\*\*2\] is also undefined. |
| `batch_shape` | Shape of a single sample from a single event index as a `TensorShape`. <br /> May be partially defined or unknown. The batch dimensions are indexes into independent, non-identical parameterizations of this distribution. |
| `dtype` | The `DType` of `Tensor`s handled by this `Distribution`. |
| `event_shape` | Shape of a single sample from a single batch as a `TensorShape`. <br /> May be partially defined or unknown. |
| `experimental_shard_axis_names` | The list or structure of lists of active shard axis names. |
| `name` | Name prepended to all ops created by this `Distribution`. |
| `name_scope` | Returns a [`tf.name_scope`](https://www.tensorflow.org/api_docs/python/tf/name_scope) instance for this class. |
| `non_trainable_variables` | Sequence of non-trainable variables owned by this module and its submodules. <br /> > [!NOTE] > **Note:** this method uses reflection to find variables on the current instance and submodules. For performance reasons you may wish to cache the result of calling this method if you don't expect the return value to change. |
| `parameters` | Dictionary of parameters used to instantiate this `Distribution`. |
| `reparameterization_type` | Describes how samples from the distribution are reparameterized. Currently this is one of the static instances `tfd.FULLY_REPARAMETERIZED` or `tfd.NOT_REPARAMETERIZED`. |
| `submodules` | Sequence of all sub-modules. <br /> Submodules are modules which are properties of this module, or found as properties of modules which are properties of this module (and so on). a = tf.Module() b = tf.Module() c = tf.Module() a.b = b b.c = c list(a.submodules) == [b, c] True list(b.submodules) == [c] True list(c.submodules) == [] True <br /> |
| `trainable_variables` | Sequence of trainable variables owned by this module and its submodules. <br /> > [!NOTE] > **Note:** this method uses reflection to find variables on the current instance and submodules. For performance reasons you may wish to cache the result of calling this method if you don't expect the return value to change. |
| `validate_args` | Python `bool` indicating possibly expensive checks are enabled. |
| `variables` | Sequence of variables owned by this module and its submodules. > [!NOTE] > **Note:** this method uses reflection to find variables on the current instance and submodules. For performance reasons you may wish to cache the result of calling this method if you don't expect the return value to change. |

## Methods

### `batch_shape_tensor`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L992-L1030)

    batch_shape_tensor(
        name='batch_shape_tensor'
    )

Shape of a single sample from a single event index as a 1-D `Tensor`.

The batch dimensions are indexes into independent, non-identical
parameterizations of this distribution.

<br />

<br />

<br />

| Args ||
|---|---|
| `name` | name to give to the op |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `batch_shape` | `Tensor`. |

<br />

### `cdf`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1411-L1429)

    cdf(
        value, name='cdf', **kwargs
    )

Cumulative distribution function.

Given random variable `X`, the cumulative distribution function `cdf` is:

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

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `cdf` | a `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. |

<br />

### `copy`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L896-L924)

    copy(
        **override_parameters_kwargs
    )

Creates a deep copy of the distribution.

> [!NOTE]
> **Note:** the copy distribution may continue to depend on the original initialization arguments.

<br />

<br />

<br />

| Args ||
|---|---|
| `**override_parameters_kwargs` | String/value dictionary of initialization arguments to override with new values. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `distribution` | A new instance of `type(self)` initialized from the union of self.parameters and override_parameters_kwargs, i.e., `dict(self.parameters, **override_parameters_kwargs)`. |

<br />

### `covariance`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1648-L1686)

    covariance(
        name='covariance', **kwargs
    )

Covariance.

Covariance is (possibly) defined only for non-scalar-event distributions.

For example, for a length-`k`, vector-valued distribution, it is calculated
as,

    Cov[i, j] = Covariance(X_i, X_j) = E[(X_i - E[X_i]) (X_j - E[X_j])]

where `Cov` is a (batch of) `k x k` matrix, `0 <= (i, j) < k`, and `E`
denotes expectation.

Alternatively, for non-vector, multivariate distributions (e.g.,
matrix-valued, Wishart), `Covariance` shall return a (batch of) matrices
under some vectorization of the events, i.e.,

    Cov[i, j] = Covariance(Vec(X)_i, Vec(X)_j) = [as above]

where `Cov` is a (batch of) `k' x k'` matrices,
`0 <= (i, j) < k' = reduce_prod(event_shape)`, and `Vec` is some function
mapping indices of this distribution's event dimensions to indices of a
length-`k'` vector.

<br />

<br />

<br />

| Args ||
|---|---|
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `covariance` | Floating-point `Tensor` with shape `[B1, ..., Bn, k', k']` where the first `n` dimensions are batch coordinates and `k' = reduce_prod(self.event_shape)`. |

<br />

### `cross_entropy`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1701-L1724)

    cross_entropy(
        other, name='cross_entropy'
    )

Computes the (Shannon) cross entropy.

Denote this distribution (`self`) by `P` and the `other` distribution by
`Q`. Assuming `P, Q` are absolutely continuous with respect to
one another and permit densities `p(x) dr(x)` and `q(x) dr(x)`, (Shannon)
cross entropy is defined as:

    H[P, Q] = E_p[-log q(X)] = -int_F p(x) log q(x) dr(x)

where `F` denotes the support of the random variable `X ~ P`.

<br />

<br />

<br />

| Args ||
|---|---|
| `other` | [`tfp.distributions.Distribution`](https://www.tensorflow.org/probability/api_docs/python/tfp/distributions/Distribution) instance. |
| `name` | Python `str` prepended to names of ops created by this function. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `cross_entropy` | `self.dtype` `Tensor` with shape `[B1, ..., Bn]` representing `n` different calculations of (Shannon) cross entropy. |

<br />

### `entropy`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1524-L1527)

    entropy(
        name='entropy', **kwargs
    )

Shannon entropy in nats.

### `event_shape_tensor`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1099-L1125)

    event_shape_tensor(
        name='event_shape_tensor'
    )

Shape of a single sample from a single batch as a 1-D int32 `Tensor`.

<br />

<br />

<br />

| Args ||
|---|---|
| `name` | name to give to the op |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `event_shape` | `Tensor`. |

<br />

### `experimental_default_event_space_bijector`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1768-L1797)

    experimental_default_event_space_bijector(
        *args, **kwargs
    )

Bijector mapping the reals (R\*\*n) to the event space of the distribution.

Distributions with continuous support may implement
`_default_event_space_bijector` which returns a subclass of
[`tfp.bijectors.Bijector`](https://www.tensorflow.org/probability/api_docs/python/tfp/bijectors/Bijector) that maps R\*\*n to the distribution's event space.
For example, the default bijector for the `Beta` distribution
is [`tfp.bijectors.Sigmoid()`](https://www.tensorflow.org/probability/api_docs/python/tfp/bijectors/Sigmoid), which maps the real line to `[0, 1]`, the
support of the `Beta` distribution. The default bijector for the
`CholeskyLKJ` distribution is [`tfp.bijectors.CorrelationCholesky`](https://www.tensorflow.org/probability/api_docs/python/tfp/bijectors/CorrelationCholesky), which
maps R\^(k \* (k-1) // 2) to the submanifold of k x k lower triangular
matrices with ones along the diagonal.

The purpose of `experimental_default_event_space_bijector` is
to enable gradient descent in an unconstrained space for Variational
Inference and Hamiltonian Monte Carlo methods. Some effort has been made to
choose bijectors such that the tails of the distribution in the
unconstrained space are between Gaussian and Exponential.

For distributions with discrete event space, or for which TFP currently
lacks a suitable bijector, this function returns `None`.

<br />

<br />

<br />

| Args ||
|---|---|
| `*args` | Passed to implementation `_default_event_space_bijector`. |
| `**kwargs` | Passed to implementation `_default_event_space_bijector`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `event_space_bijector` | `Bijector` instance or `None`. |

<br />

### `experimental_fit`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1799-L1847)

    @classmethod
    experimental_fit(
        value, sample_ndims=1, validate_args=False, **init_kwargs
    )

Instantiates a distribution that maximizes the likelihood of `x`.

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | a `Tensor` valid sample from this distribution family. |
| `sample_ndims` | Positive `int` Tensor number of leftmost dimensions of `value` that index i.i.d. samples. Default value: `1`. |
| `validate_args` | Python `bool`, default `False`. When `True`, distribution parameters are checked for validity despite possibly degrading runtime performance. When `False`, invalid inputs may silently render incorrect outputs. Default value: `False`. |
| `**init_kwargs` | Additional keyword arguments passed through to `cls.__init__`. These take precedence in case of collision with the fitted parameters; for example, `tfd.Normal.experimental_fit([1., 1.], scale=20.)` returns a Normal distribution with `scale=20.` rather than the maximum likelihood parameter `scale=0.`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `maximum_likelihood_instance` | instance of `cls` with parameters that maximize the likelihood of `value`. |

<br />

### `experimental_local_measure`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1872-L1914)

    experimental_local_measure(
        value, backward_compat=False, **kwargs
    )

Returns a log probability density together with a `TangentSpace`.

A `TangentSpace` allows us to calculate the correct push-forward
density when we apply a transformation to a `Distribution` on
a strict submanifold of R\^n (typically via a `Bijector` in the
`TransformedDistribution` subclass). The density correction uses
the basis of the tangent space.

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `backward_compat` | `bool` specifying whether to fall back to returning `FullSpace` as the tangent space, and representing R\^n with the standard basis. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `log_prob` | a `Tensor` representing the log probability density, of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. |
| `tangent_space` | a `TangentSpace` object (by default `FullSpace`) representing the tangent space to the manifold at `value`. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| UnspecifiedTangentSpaceError if `backward_compat` is False and the `_experimental_tangent_space` attribute has not been defined. ||

<br />

### `experimental_sample_and_log_prob`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1229-L1259)

    experimental_sample_and_log_prob(
        sample_shape=(), seed=None, name='sample_and_log_prob', **kwargs
    )

Samples from this distribution and returns the log density of the sample.

The default implementation simply calls `sample` and `log_prob`:

    def _sample_and_log_prob(self, sample_shape, seed, **kwargs):
      x = self.sample(sample_shape=sample_shape, seed=seed, **kwargs)
      return x, self.log_prob(x, **kwargs)

However, some subclasses may provide more efficient and/or numerically
stable implementations.

<br />

<br />

<br />

| Args ||
|---|---|
| `sample_shape` | integer `Tensor` desired shape of samples to draw. Default value: `()`. |
| `seed` | PRNG seed; see [`tfp.random.sanitize_seed`](https://www.tensorflow.org/probability/api_docs/python/tfp/random/sanitize_seed) for details. Default value: `None`. |
| `name` | name to give to the op. Default value: `'sample_and_log_prob'`. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `samples` | a `Tensor`, or structure of `Tensor`s, with prepended dimensions `sample_shape`. |
| `log_prob` | a `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. |

<br />

### `is_scalar_batch`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1156-L1168)

    is_scalar_batch(
        name='is_scalar_batch'
    )

Indicates that `batch_shape == []`.

<br />

<br />

<br />

| Args ||
|---|---|
| `name` | Python `str` prepended to names of ops created by this function. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `is_scalar_batch` | `bool` scalar `Tensor`. |

<br />

### `is_scalar_event`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1142-L1154)

    is_scalar_event(
        name='is_scalar_event'
    )

Indicates that `event_shape == []`.

<br />

<br />

<br />

| Args ||
|---|---|
| `name` | Python `str` prepended to names of ops created by this function. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `is_scalar_event` | `bool` scalar `Tensor`. |

<br />

### `kl_divergence`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1730-L1761)

    kl_divergence(
        other, name='kl_divergence'
    )

Computes the Kullback--Leibler divergence.

Denote this distribution (`self`) by `p` and the `other` distribution by
`q`. Assuming `p, q` are absolutely continuous with respect to reference
measure `r`, the KL divergence is defined as:

    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]

where `F` denotes the support of the random variable `X ~ p`, `H[., .]`
denotes (Shannon) cross entropy, and `H[.]` denotes (Shannon) entropy.

<br />

<br />

<br />

| Args ||
|---|---|
| `other` | [`tfp.distributions.Distribution`](https://www.tensorflow.org/probability/api_docs/python/tfp/distributions/Distribution) instance. |
| `name` | Python `str` prepended to names of ops created by this function. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `kl_divergence` | `self.dtype` `Tensor` with shape `[B1, ..., Bn]` representing `n` different calculations of the Kullback-Leibler divergence. |

<br />

### `log_cdf`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1373-L1395)

    log_cdf(
        value, name='log_cdf', **kwargs
    )

Log cumulative distribution function.

Given random variable `X`, the cumulative distribution function `cdf` is:

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

Often, a numerical approximation can be used for `log_cdf(x)` that yields
a more accurate answer than simply taking the logarithm of the `cdf` when
`x << -1`.

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `logcdf` | a `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. |

<br />

### `log_prob`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1275-L1287)

    log_prob(
        value, name='log_prob', **kwargs
    )

Log probability density/mass function.

Additional documentation from `PixelCNN`:

Log probability function with optional conditional input.

Calculates the log probability of a batch of data under the modeled
distribution (or conditional distribution, if conditional input is
provided).

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `Tensor` or Numpy array of image data. May have leading batch dimension(s), which must broadcast to the leading batch dimensions of `conditional_input`. |
| `conditional_input` | `Tensor` on which to condition the distribution (e.g. class labels), or `None`. May have leading batch dimension(s), which must broadcast to the leading batch dimensions of `value`. |
| `training` | `bool` or `None`. If `bool`, it controls the dropout layer, where `True` implies dropout is active. If `None`, it defaults to `tf_keras.backend.learning_phase()`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `log_prob_values` | `Tensor`. |

<br />

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `log_prob` | a `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. |

<br />

### `log_survival_function`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1452-L1476)

    log_survival_function(
        value, name='log_survival_function', **kwargs
    )

Log survival function.

Given random variable `X`, the survival function is defined:

    log_survival_function(x) = Log[ P[X > x] ]
                             = Log[ 1 - P[X <= x] ]
                             = Log[ 1 - cdf(x) ]

Typically, different numerical approximations can be used for the log
survival function, which are more accurate than `1 - cdf(x)` when `x >> 1`.

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. ||

<br />

### `mean`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1533-L1536)

    mean(
        name='mean', **kwargs
    )

Mean.

### `mode`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1692-L1695)

    mode(
        name='mode', **kwargs
    )

Mode.

### `param_shapes`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L701-L727)

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

Shapes of parameters given the desired shape of a call to `sample()`. (deprecated)

> [!WARNING]
> **Deprecated:** THIS FUNCTION IS DEPRECATED. It will be removed after 2021-03-01. Instructions for updating: The `param_shapes` method of `tfd.Distribution` is deprecated; use `parameter_properties` instead.

This is a class method that describes what key/value arguments are required
to instantiate the given `Distribution` so that a particular shape is
returned for that instance's call to `sample()`.

Subclasses should override class method `_param_shapes`.

<br />

<br />

<br />

| Args ||
|---|---|
| `sample_shape` | `Tensor` or python list/tuple. Desired shape of a call to `sample()`. |
| `name` | name to prepend ops with. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `dict` of parameter name to `Tensor` shapes. ||

<br />

### `param_static_shapes`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L729-L769)

    @classmethod
    param_static_shapes(
        sample_shape
    )

param_shapes with static (i.e. `TensorShape`) shapes. (deprecated)

> [!WARNING]
> **Deprecated:** THIS FUNCTION IS DEPRECATED. It will be removed after 2021-03-01. Instructions for updating: The `param_static_shapes` method of `tfd.Distribution` is deprecated; use `parameter_properties` instead.

This is a class method that describes what key/value arguments are required
to instantiate the given `Distribution` so that a particular shape is
returned for that instance's call to `sample()`. Assumes that the sample's
shape is known statically.

Subclasses should override class method `_param_shapes` to return
constant-valued tensors when constant values are fed.

<br />

<br />

<br />

| Args ||
|---|---|
| `sample_shape` | `TensorShape` or python list/tuple. Desired shape of a call to `sample()`. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `dict` of parameter name to `TensorShape`. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | if `sample_shape` is a `TensorShape` and is not fully defined. |

<br />

### `parameter_properties`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L655-L699)

    @classmethod
    parameter_properties(
        dtype=tf.float32, num_classes=None
    )

Returns a dict mapping constructor arg names to property annotations.

This dict should include an entry for each of the distribution's
`Tensor`-valued constructor arguments.

Distribution subclasses are not required to implement
`_parameter_properties`, so this method may raise `NotImplementedError`.
Providing a `_parameter_properties` implementation enables several advanced
features, including:

- Distribution batch slicing (`sliced_distribution = distribution[i:j]`).
- Automatic inference of `_batch_shape` and `_batch_shape_tensor`, which must otherwise be computed explicitly.
- Automatic instantiation of the distribution within TFP's internal property tests.
- Automatic construction of 'trainable' instances of the distribution using appropriate bijectors to avoid violating parameter constraints. This enables the distribution family to be used easily as a surrogate posterior in variational inference.

In the future, parameter property annotations may enable additional
functionality; for example, returning Distribution instances from
[`tf.vectorized_map`](https://www.tensorflow.org/api_docs/python/tf/vectorized_map).

<br />

<br />

<br />

| Args ||
|---|---|
| `dtype` | Optional float `dtype` to assume for continuous-valued parameters. Some constraining bijectors require advance knowledge of the dtype because certain constants (e.g., `tfb.Softplus.low`) must be instantiated with the same dtype as the values to be transformed. |
| `num_classes` | Optional `int` `Tensor` number of classes to assume when inferring the shape of parameters for categorical-like distributions. Otherwise ignored. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `parameter_properties` | A `str ->`tfp.python.internal.parameter_properties.ParameterProperties`dict mapping constructor argument names to`ParameterProperties\` instances. |

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `NotImplementedError` | if the distribution class does not implement `_parameter_properties`. |

<br />

### `prob`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1303-L1315)

    prob(
        value, name='prob', **kwargs
    )

Probability density/mass function.

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `prob` | a `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. |

<br />

### `quantile`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1555-L1573)

    quantile(
        value, name='quantile', **kwargs
    )

Quantile function. Aka 'inverse cdf' or 'percent point function'.

Given random variable `X` and `p in [0, 1]`, the `quantile` is:

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

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `quantile` | a `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. |

<br />

### `sample`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1189-L1205)

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

Generate samples of the specified shape.

Note that a call to `sample()` without arguments will generate a single
sample.

Additional documentation from `PixelCNN`:

Samples from the distribution, with optional conditional input.

<br />

<br />

<br />

| Args ||
|---|---|
| `n` | `int`, number of samples desired. |
| `seed` | PRNG seed; see [`tfp.random.sanitize_seed`](https://www.tensorflow.org/probability/api_docs/python/tfp/random/sanitize_seed) for details. |
| `conditional_input` | `Tensor` on which to condition the distribution (e.g. class labels), or `None`. |
| `training` | `bool` or `None`. If `bool`, it controls the dropout layer, where `True` implies dropout is active. If `None`, it defers to Keras' handling of train/eval status. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `samples` | a `Tensor` of shape `[n, height, width, num_channels]`. |

<br />

<br />

<br />

<br />

| Args ||
|---|---|
| `sample_shape` | 0D or 1D `int32` `Tensor`. Shape of the generated samples. |
| `seed` | PRNG seed; see [`tfp.random.sanitize_seed`](https://www.tensorflow.org/probability/api_docs/python/tfp/random/sanitize_seed) for details. |
| `name` | name to give to the op. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `samples` | a `Tensor` with prepended dimensions `sample_shape`. |

<br />

### `stddev`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1613-L1642)

    stddev(
        name='stddev', **kwargs
    )

Standard deviation.

Standard deviation is defined as,

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

where `X` is the random variable associated with this distribution, `E`
denotes expectation, and `stddev.shape = batch_shape + event_shape`.

<br />

<br />

<br />

| Args ||
|---|---|
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `stddev` | Floating-point `Tensor` with shape identical to `batch_shape + event_shape`, i.e., the same shape as `self.mean()`. |

<br />

### `survival_function`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1498-L1518)

    survival_function(
        value, name='survival_function', **kwargs
    )

Survival function.

Given random variable `X`, the survival function is defined:

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

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. ||

<br />

### `unnormalized_log_prob`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1335-L1357)

    unnormalized_log_prob(
        value, name='unnormalized_log_prob', **kwargs
    )

Potentially unnormalized log probability density/mass function.

This function is similar to `log_prob`, but does not require that the
return value be normalized. (Normalization here refers to the total
integral of probability being one, as it should be by definition for any
probability distribution.) This is useful, for example, for distributions
where the normalization constant is difficult or expensive to compute. By
default, this simply calls `log_prob`.

<br />

<br />

<br />

| Args ||
|---|---|
| `value` | `float` or `double` `Tensor`. |
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `unnormalized_log_prob` | a `Tensor` of shape `sample_shape(x) + self.batch_shape` with values of type `self.dtype`. |

<br />

### `variance`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L1579-L1607)

    variance(
        name='variance', **kwargs
    )

Variance.

Variance is defined as,

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

where `X` is the random variable associated with this distribution, `E`
denotes expectation, and `Var.shape = batch_shape + event_shape`.

<br />

<br />

<br />

| Args ||
|---|---|
| `name` | Python `str` prepended to names of ops created by this function. |
| `**kwargs` | Named arguments forwarded to subclass implementation. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `variance` | Floating-point `Tensor` with shape identical to `batch_shape + event_shape`, i.e., the same shape as `self.mean()`. |

<br />

### `with_name_scope`

    @classmethod
    with_name_scope(
        method
    )

Decorator to automatically enter the module name scope.

    class MyModule(tf.Module):
      @tf.Module.with_name_scope
      def __call__(self, x):
        if not hasattr(self, 'w'):
          self.w = tf.Variable(tf.random.normal([x.shape[1], 3]))
        return tf.matmul(x, self.w)

Using the above module would produce [`tf.Variable`](https://www.tensorflow.org/api_docs/python/tf/Variable)s and [`tf.Tensor`](https://www.tensorflow.org/api_docs/python/tf/Tensor)s whose
names included the module name:

    mod = MyModule()
    mod(tf.ones([1, 2]))
    <tf.Tensor: shape=(1, 3), dtype=float32, numpy=..., dtype=float32)>
    mod.w
    <tf.Variable 'my_module/Variable:0' shape=(2, 3) dtype=float32,
    numpy=..., dtype=float32)>

<br />

<br />

<br />

| Args ||
|---|---|
| `method` | The method to wrap. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| The original method wrapped such that it enters the module's name scope. ||

<br />

### `__getitem__`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L825-L852)

    __getitem__(
        slices
    )

Slices the batch axes of this distribution, returning a new instance.

    b = tfd.Bernoulli(logits=tf.zeros([3, 5, 7, 9]))
    b.batch_shape  # => [3, 5, 7, 9]
    b2 = b[:, tf.newaxis, ..., -2:, 1::2]
    b2.batch_shape  # => [3, 1, 5, 2, 4]

    x = tf.random.normal([5, 3, 2, 2])
    cov = tf.matmul(x, x, transpose_b=True)
    chol = tf.linalg.cholesky(cov)
    loc = tf.random.normal([4, 1, 3, 1])
    mvn = tfd.MultivariateNormalTriL(loc, chol)
    mvn.batch_shape  # => [4, 5, 3]
    mvn.event_shape  # => [2]
    mvn2 = mvn[:, 3:, ..., ::-1, tf.newaxis]
    mvn2.batch_shape  # => [4, 2, 3, 1]
    mvn2.event_shape  # => [2]

<br />

<br />

<br />

| Args ||
|---|---|
| `slices` | slices from the \[\] operator |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `dist` | A new `tfd.Distribution` instance with sliced parameters. |

<br />

### `__iter__`

[View source](https://github.com/tensorflow/probability/blob/v0.25.0/tensorflow_probability/python/distributions/distribution.py#L854-L855)

    __iter__()