nessai.proposal.base
====================

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

.. autoapi-nested-parse::

   Base object for all proposal classes.

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   nessai.proposal.base.Proposal


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

.. py:class:: Proposal(model, rng: Optional[numpy.random.Generator] = None)

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


   
   Base proposal object


   :Parameters:

       **model: obj**
           User-defined model

       **rng: np.random.Generator, optional**
           Random number generator. If not provided, a new generator is created.














   ..
       !! processed by numpydoc !!

   .. py:property:: initialised

      
      Boolean that indicates if the proposal is initialised or not.
















      ..
          !! processed by numpydoc !!


   .. py:method:: initialise()

      
      Initialise the proposal
















      ..
          !! processed by numpydoc !!


   .. py:method:: update_output(output: str) -> None

      
      Update the output directory.

      Only updates the output if the proposal has an output attribute.

      :Parameters:

          **output: str**
              Path to the output directory














      ..
          !! processed by numpydoc !!


   .. py:method:: evaluate_likelihoods()

      
      Evaluate the likelihoods for the pool of live points.
















      ..
          !! processed by numpydoc !!


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


      
      New a new point given the old point
















      ..
          !! processed by numpydoc !!


   .. py:method:: train(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(model)

      
      Resume the proposal with the model
















      ..
          !! processed by numpydoc !!