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

.. py:module:: nessai.utils.multiprocessing

.. autoapi-nested-parse::

   Utilities related to multiprocessing.

   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   nessai.utils.multiprocessing.initialise_pool_variables
   nessai.utils.multiprocessing.log_likelihood_wrapper
   nessai.utils.multiprocessing.get_n_pool



Attributes
~~~~~~~~~~

.. autoapisummary::

   nessai.utils.multiprocessing.logger


.. py:data:: logger
   

   
















   ..
       !! processed by numpydoc !!

.. py:function:: initialise_pool_variables(model)

   
   Prepare the model for use with a multiprocessing pool.

   Makes a global copy of the model. Should be called before initialising
   a pool or passed to the :code:`initializer` argument with the model as one
   of the :code:`initargs`.

   :Parameters:

       **model** : :obj:`nessai.model.Model`
           Model to be copied to a global variable.














   ..
       !! processed by numpydoc !!

.. py:function:: log_likelihood_wrapper(x)

   
   Wrapper for the log-likelihood for use with multiprocessing.

   Should be used alongside
   :py:func:`nessai.utils.multiprocessing.initialise_pool_variables`

   :Parameters:

       **x** : :obj:`numpy.ndarray`
           Array of samples.

   :Returns:

       :obj:`numpy.ndarray`
           Array of log-likelihoods.













   ..
       !! processed by numpydoc !!

.. py:function:: get_n_pool(pool)

   
   Determine the number of processes in a multiprocessing pool.


   :Parameters:

       **pool** : object
           Multiprocessing pool or similar.














   ..
       !! processed by numpydoc !!