tfp.distributions.kl_divergence

View source on GitHub

Get the KL-divergence KL(distribution_a || distribution_b).

Aliases:

tfp.distributions.kl_divergence(
    distribution_a,
    distribution_b,
    allow_nan_stats=True,
    name=None
)

If there is no KL method registered specifically for type(distribution_a) and type(distribution_b), then the class hierarchies of these types are searched.

If one KL method is registered between any pairs of classes in these two parent hierarchies, it is used.

If more than one such registered method exists, the method whose registered classes have the shortest sum MRO paths to the input types is used.

If more than one such shortest path exists, the first method identified in the search is used (favoring a shorter MRO distance to type(distribution_a)).

Args:

  • distribution_a: The first distribution.
  • distribution_b: The second distribution.
  • allow_nan_stats: Python bool, default True. When True, statistics (e.g., mean, mode, variance) use the value "NaN" to indicate the result is undefined. When False, an exception is raised if one or more of the statistic's batch members are undefined.
  • name: Python str name prefixed to Ops created by this class.

Returns:

A Tensor with the batchwise KL-divergence between distribution_a and distribution_b.

Raises:

  • NotImplementedError: If no KL method is defined for distribution types of distribution_a and distribution_b.

Built-in KL(distribution_a || distribution_b) registrations:

                     distribution_a || distribution_b
==========================================================================
                          Bernoulli || Bernoulli
                               Beta || Beta
                          Blockwise || Blockwise
                        Categorical || Categorical
                                Chi || Chi
                               Chi2 || Chi2
                               Chi2 || Gamma
                                       + Exponential
                          Dirichlet || Dirichlet
                              Gamma || Chi2
                      Exponential +    
                              Gamma || Gamma
                      Exponential +    + Exponential
                    GaussianProcess || MultivariateNormalLinearOperator
   GaussianProcessRegressionModel +    + MultivariateNormalDiag
                                       + MultivariateNormalDiagPlusLowRank
                                       + MultivariateNormalFullCovariance
                                       + MultivariateNormalTriL
                                       + VariationalGaussianProcess
                    GaussianProcess || Normal
   GaussianProcessRegressionModel +    
                             Gumbel || Gumbel
                         HalfNormal || HalfNormal
                        Independent || Independent
        JointDistributionSequential || JointDistributionSequential
           JointDistributionNamed +    + JointDistributionNamed
                            Laplace || Laplace
   MultivariateNormalLinearOperator || GaussianProcess
           MultivariateNormalDiag +    + GaussianProcessRegressionModel
MultivariateNormalDiagPlusLowRank +    
 MultivariateNormalFullCovariance +    
           MultivariateNormalTriL +    
       VariationalGaussianProcess +    
   MultivariateNormalLinearOperator || MultivariateNormalLinearOperator
           MultivariateNormalDiag +    + MultivariateNormalDiag
MultivariateNormalDiagPlusLowRank +    + MultivariateNormalDiagPlusLowRank
 MultivariateNormalFullCovariance +    + MultivariateNormalFullCovariance
           MultivariateNormalTriL +    + MultivariateNormalTriL
       VariationalGaussianProcess +    + VariationalGaussianProcess
                             Normal || GaussianProcess
                                       + GaussianProcessRegressionModel
                             Normal || Normal
                  OneHotCategorical || OneHotCategorical
                             Pareto || Pareto
                    ProbitBernoulli || ProbitBernoulli
                             Sample || Sample
                            Uniform || Uniform
                           VonMises || VonMises
                 _BaseDeterministic || Distribution
                    Deterministic +    + Autoregressive
              VectorDeterministic +    + BatchReshape
                                       + Bernoulli
                                       + Beta
                                       + Binomial
                                       + Blockwise
                                       + 72 more
                              _Cast || _Cast