:py:mod:`nessai.proposal.base`
==============================

.. py:module:: nessai.proposal.base

.. autoapi-nested-parse::

   Base object for all proposal classes.

   ..
       !! processed by numpydoc !!


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

Classes
~~~~~~~

.. autoapisummary::

   nessai.proposal.base.Proposal




Attributes
~~~~~~~~~~

.. autoapisummary::

   nessai.proposal.base.logger


.. py:data:: logger
   

   
















   ..
       !! processed by numpydoc !!

.. py:class:: Proposal(model)

   Bases: :py:obj:`abc.ABC`

   
   Base proposal object


   :Parameters:

       **model: obj**
           User-defined model














   ..
       !! processed by numpydoc !!
   .. py:method:: initialised(self)
      :property:

      
      Boolean that indicates if the proposal is initialised or not.
















      ..
          !! processed by numpydoc !!

   .. py:method:: initialise(self)

      
      Initialise the proposal
















      ..
          !! processed by numpydoc !!

   .. py:method:: evaluate_likelihoods(self)

      
      Evaluate the likelihoods for the pool of live points.
















      ..
          !! processed by numpydoc !!

   .. py:method:: draw(self, old_param)
      :abstractmethod:

      
      New a new point given the old point
















      ..
          !! processed by numpydoc !!

   .. py:method:: test_draw(self)

      
      Test the draw method to ensure it returns a sample in the correct
      format and the the log prior is computed.
















      ..
          !! processed by numpydoc !!

   .. py:method:: train(self, x, **kwargs)

      
      Train the proposal method


      :Parameters:

          **x: array_like**
              Array of live points to use for training

          **kwargs:**
              Any of keyword arguments














      ..
          !! processed by numpydoc !!

   .. py:method:: resume(self, model)

      
      Resume the proposal with the model
















      ..
          !! processed by numpydoc !!