<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/transformed_distribution.py#L667-L701) |

A Transformed Distribution.

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

    tfp.distributions.TransformedDistribution(
        distribution,
        bijector,
        kwargs_split_fn=_default_kwargs_split_fn,
        validate_args=False,
        parameters=None,
        name=None
    )

### Used in the notebooks

| Used in the tutorials |
|---|
| - [Approximate inference for STS models with non-Gaussian observations](https://www.tensorflow.org/probability/examples/STS_approximate_inference_for_models_with_non_Gaussian_observations) |

A `TransformedDistribution` models `p(y)` given a base distribution `p(x)`,
and a deterministic, invertible, differentiable transform, `Y = g(X)`. The
transform is typically an instance of the `Bijector` class and the base
distribution is typically an instance of the `Distribution` class.

A `Bijector` is expected to implement the following functions:

- `forward`,
- `inverse`,
- `inverse_log_det_jacobian`.

  The semantics of these functions are outlined in the `Bijector` documentation.

  We now describe how a `TransformedDistribution` alters the input/outputs of a
  `Distribution` associated with a random variable (rv) `X`.

  Write `cdf(Y=y)` for an absolutely continuous cumulative distribution function
  of random variable `Y`; write the probability density function
  `pdf(Y=y) := d^k / (dy_1,...,dy_k) cdf(Y=y)` for its derivative wrt to `Y`
  evaluated at `y`. Assume that `Y = g(X)` where `g` is a deterministic
  diffeomorphism, i.e., a non-random, continuous, differentiable, and invertible
  function. Write the inverse of `g` as `X = g^{-1}(Y)` and `(J o g)(x)` for
  the Jacobian of `g` evaluated at `x`.

  A `TransformedDistribution` implements the following operations:
  - `sample`
    Mathematically: `Y = g(X)`
    Programmatically: `bijector.forward(distribution.sample(...))`

  - `log_prob`
    Mathematically: `(log o pdf)(Y=y) = (log o pdf o g^{-1})(y)
    + (log o abs o det o J o g^{-1})(y)`
    Programmatically: `(distribution.log_prob(bijector.inverse(y))
    + bijector.inverse_log_det_jacobian(y))`

  - `log_cdf`
    Mathematically: `(log o cdf)(Y=y) = (log o cdf o g^{-1})(y)`
    Programmatically: `distribution.log_cdf(bijector.inverse(x))`

  - and similarly for: `cdf`, `prob`, `log_survival_function`,
    `survival_function`.

  Kullback-Leibler divergence is also well defined for `TransformedDistribution`
  instances that have matching bijectors. Bijector matching is performed via
  the [`Bijector.eq`](https://www.tensorflow.org/probability/api_docs/python/tfp/bijectors/Bijector#__eq__) method, e.g., `td1.bijector == td2.bijector`, as part
  of the KL calculation. If the underlying bijectors do not match, a
  `NotImplementedError` is raised when calling `kl_divergence`. This is the
  same behavior as calling `kl_divergence` when two distributions do not have
  a registered KL divergence.

  > [!NOTE]
  > **Note:** Due to the current constraints imposed on bijector equality testing, `kl_divergence` may behave differently in eager mode computation vs. traced computation. For example, if a TD Bijector's parameters are `Tensor` objects, and are themselves derived from e.g. a Variable, some stateful operation, or from an argument to a [`tf.function`](https://www.tensorflow.org/api_docs/python/tf/function) then Bijector equality cannot be known during the call to `kl_divergence` and the bijectors are assumed unequal. In this case, calling `kl_divergence` may raise an exception in graph / tf.function mode, but work just fine in eager / numpy mode.

  A simple example constructing a Log-Normal distribution from a Normal
  distribution:

      tfd = tfp.distributions
      tfb = tfp.bijectors
      log_normal = tfd.TransformedDistribution(
        distribution=tfd.Normal(loc=0., scale=1.),
        bijector=tfb.Exp(),
        name='LogNormalTransformedDistribution')

  A `LogNormal` made from callables:

      tfd = tfp.distributions
      tfb = tfp.bijectors
      log_normal = tfd.TransformedDistribution(
        distribution=tfd.Normal(loc=0., scale=1.),
        bijector=tfb.Inline(
          forward_fn=tf.exp,
          inverse_fn=tf.log,
          inverse_log_det_jacobian_fn=(
            lambda y: -tf.reduce_sum(tf.log(y), axis=-1)),
        name='LogNormalTransformedDistribution')

  Another example constructing a Normal from a StandardNormal:

      tfd = tfp.distributions
      tfb = tfp.bijectors
      normal = tfd.TransformedDistribution(
        distribution=tfd.Normal(loc=0., scale=1.),
        bijector=tfb.Shift(shift=-1.)(tfb.Scale(scale=2.)),
        name='NormalTransformedDistribution')

  A `TransformedDistribution`'s `batch_shape` is derived by *broadcasting* the
  batch shapes of the base distribution and the bijector. The base distribution
  is then itself implicitly lifted to the broadcast batch shape. For example, in

      tfd = tfp.distributions
      tfb = tfp.bijectors
      batch_normal = tfd.TransformedDistribution(
        distribution=tfd.Normal(loc=0., scale=1.),
        bijector=tfb.Shift(shift=[-1., 0., 1.]),
        name='BatchNormalTransformedDistribution')

  the base distribution has batch shape `[]`, and the bijector applied to this
  distribution contributes a batch shape of `[3]` (obtained as
  `bijector.experimental_batch_shape(
  x_event_ndims=tf.rank(distribution.event_shape))`, yielding the broadcast
  shape `batch_normal.batch_shape == [3]`. Although sampling from the base
  distribution would ordinarily return just a single value, calling
  `batch_normal.sample()` will return a Tensor of 3 independent values, just as
  if the base distribution had explicitly followed the broadcast batch shape.

  The `event_shape` of a `TransformedDistribution` is the `forward_event_shape`
  of the bijector applied to the `event_shape` of the base distribution.

  `tfd.Sample` or `tfd.Independent` may be used to add extra IID dimensions to
  the `event_shape` of the base distribution before the bijector operates on it.
  The following example demonstrates how to construct a multivariate Normal as a
  `TransformedDistribution`, by adding a rank-1 IID dimension to the
  `event_shape` of a standard Normal and applying `tfb.ScaleMatvecTriL`.

      tfd = tfp.distributions
      tfb = tfp.bijectors
      # We will create two MVNs with batch_shape = event_shape = 2.
      mean = [[-1., 0],      # batch:0
              [0., 1]]       # batch:1
      chol_cov = [[[1., 0],
                   [0, 1]],  # batch:0
                  [[1, 0],
                   [2, 2]]]  # batch:1
      mvn1 = tfd.TransformedDistribution(
          distribution=tfd.Sample(
              tfd.Normal(loc=[0., 0], scale=1.),  # base_dist.batch_shape == [2]
              sample_shape=[2])                   # base_dist.event_shape == [2]
          bijector=tfb.Shift(shift=mean)(tfb.ScaleMatvecTriL(scale_tril=chol_cov)))
      mvn2 = ds.MultivariateNormalTriL(loc=mean, scale_tril=chol_cov)
      # mvn1.log_prob(x) == mvn2.log_prob(x)

If both `distribution` and `bijector` are `CompositeTensor`s, then the resulting `TransformedDistribution` instance is a `CompositeTensor` as well. Otherwise, a non-`CompositeTensor` `_TransformedDistribution` instance is created instead. Distribution subclasses that inherit from `TransformedDistribution` will also inherit from `CompositeTensor`.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `distribution` | The base distribution instance to transform. Typically an instance of `Distribution`. |
| `bijector` | The object responsible for calculating the transformation. Typically an instance of `Bijector`. |
| `kwargs_split_fn` | Python `callable` which takes a kwargs `dict` and returns a tuple of kwargs `dict`s for each of the `distribution` and `bijector` parameters respectively. Default value: `_default_kwargs_split_fn` (i.e., `lambda kwargs: (kwargs.get('distribution_kwargs', {}), kwargs.get('bijector_kwargs', {}))`) |
| `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. |
| `parameters` | Locals dict captured by subclass constructor, to be used for copy/slice re-instantiation operations. |
| `name` | Python `str` name prefixed to Ops created by this class. Default: `bijector.name + distribution.name`. |

<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. |
| `bijector` | Function transforming x =\> y. |
| `distribution` | Base distribution, p(x). |
| `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_is_sharded` | <br /> <br /> |
| `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`.

`other` types with built-in registrations: `Chi`, `ExpInverseGamma`, `GeneralizedExtremeValue`, `Gumbel`, `JohnsonSU`, `Kumaraswamy`, `LambertWDistribution`, `LambertWNormal`, `LogLogistic`, `LogNormal`, `LogitNormal`, `Moyal`, `MultivariateNormalDiag`, `MultivariateNormalDiagPlusLowRank`, `MultivariateNormalFullCovariance`, `MultivariateNormalLinearOperator`, `MultivariateNormalTriL`, `RelaxedOneHotCategorical`, `SinhArcsinh`, `TransformedDistribution`, `Weibull`

<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/transformed_distribution.py#L606-L630)

    experimental_local_measure(
        y, 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.

`other` types with built-in registrations: `Chi`, `ExpInverseGamma`, `GeneralizedExtremeValue`, `Gumbel`, `JohnsonSU`, `Kumaraswamy`, `LambertWDistribution`, `LambertWNormal`, `LogLogistic`, `LogNormal`, `LogitNormal`, `Moyal`, `MultivariateNormalDiag`, `MultivariateNormalDiagPlusLowRank`, `MultivariateNormalFullCovariance`, `MultivariateNormalLinearOperator`, `MultivariateNormalTriL`, `RelaxedOneHotCategorical`, `SinhArcsinh`, `TransformedDistribution`, `Weibull`

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

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

<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__()