nessai.flows.distributions
==========================

.. py:module:: nessai.flows.distributions

.. autoapi-nested-parse::

   Distributions to use as the 'base distribution' for normalising flows.

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   nessai.flows.distributions.MultivariateNormal
   nessai.flows.distributions.ResampledGaussian


Module Contents
---------------

.. py:class:: MultivariateNormal(shape, var=1)

   Bases: :py:obj:`glasflow.nflows.distributions.Distribution`


   
   A multivariate Normal with zero mean and specified covariance.


   :Parameters:

       **shape** : tuple
           Shape of distribution, this is used to determine the number of
           dimensions.

       **var** : float, optional
           Variance of the distribution.














   ..
       !! processed by numpydoc !!

.. py:class:: ResampledGaussian(shape: Union[int, tuple], acceptance_fn: Callable, eps: float = 0.05, truncation: int = 100, trainable: bool = False)

   Bases: :py:obj:`glasflow.distributions.ResampledGaussian`


   
   Wrapper for ResampledGaussian.

   Adds methods needed in nessai.















   ..
       !! processed by numpydoc !!

   .. py:attribute:: end_iteration

      
      Function to be called at the end of an iteration.

      For LARS this updates the estimate of the normalisation constant
      independently of the other parameters in the flow.















      ..
          !! processed by numpydoc !!


   .. py:method:: finalise(n_samples: int = 10000, n_batches: int = 10) -> None

      
      Finalise the estimate of the normalisation constant.
















      ..
          !! processed by numpydoc !!