jexplore.steps.modsel.swap
==========================

.. py:module:: jexplore.steps.modsel.swap

.. autoapi-nested-parse::

   This module defines the class for Model Selection
   steps swapping chains.



Attributes
----------

.. autoapisummary::

   jexplore.steps.modsel.swap.TSwapMS


Classes
-------

.. autoapisummary::

   jexplore.steps.modsel.swap.OrderByModel


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

.. py:data:: TSwapMS

   Temperature swap for model selection

.. py:class:: OrderByModel[Tepoch: jexplore.sampling.EpochMS, Tstate: jexplore.sampling.StateMS, Tsampling: jexplore.sampling.SamplingMS]

   Bases: :py:obj:`jexplore.steps.step.Step`\ [\ :py:obj:`Tepoch`\ , :py:obj:`Tstate`\ , :py:obj:`Tsampling`\ ]


   Swap chains to restore model ordering (temp by temp)


   .. py:method:: step(key, state)

      Pseudo drawing step

      :param key: PRNG key
      :param state: current state

      :return: new state and the boolean mask of the chains modified by the step.