:py:mod:`nessai.utils.distributions`
====================================

.. py:module:: nessai.utils.distributions

.. autoapi-nested-parse::

   Utilities for getting distributions for use in         :py:class:`~nessai.proposal.flowproposal.FlowProposal`

   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   nessai.utils.distributions.get_uniform_distribution
   nessai.utils.distributions.get_multivariate_normal



.. py:function:: get_uniform_distribution(dims, r, device='cpu')

   
   Return a torch distribution that is uniform in the number of dims
   specified.


   :Parameters:

       **dims** : int
           Number of dimensions.

       **r** : float
           Radius to use for lower and upper bounds.

       **device** : str, optional
           Device on which the distribution is placed.

   :Returns:

       :obj:`nflows.distributions.uniform.BoxUniform`
           Instance of BoxUniform which the lower and upper bounds set by
           the radius













   ..
       !! processed by numpydoc !!

.. py:function:: get_multivariate_normal(dims, var=1, device='cpu')

   
   Return a Pytorch distribution that is normally distributed in n dims
   with a given variance.


   :Parameters:

       **dims** : int
           Number of dimensions.

       **var** : float, optional
           Variance.

       **device** : str, optional
           Device on which the distribution is placed.

   :Returns:

       :obj:`nessai.flows.distributions.MultivariateNormal`
           Instance of MultivariateNormal with correct variance and dims.













   ..
       !! processed by numpydoc !!