:py:mod:`omnisolver.pt.sampler`
===============================

.. py:module:: omnisolver.pt.sampler

.. autoapi-nested-parse::

   Dimod-compatible PT sampler.



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

Classes
~~~~~~~

.. autoapisummary::

   omnisolver.pt.sampler.PTSampler




.. py:class:: PTSampler

   Bases: :py:obj:`dimod.Sampler`

   Parallel tempering samplers.

   .. py:property:: parameters

      Parameters as a dict, where keys are keyword parameters accepted by the
      sampler methods and values are lists of the properties relevent to each
      parameter.


   .. py:property:: properties

      Properties as a dict containing any additional information about the
      sampler.


   .. py:method:: sample_ising(h, J, num_replicas=10, num_pt_steps=100, num_sweeps=100, beta_min=0.01, beta_max=1.0, **parameters)

      Solve given Ising problem.

      :param h: dictionary of biases.
      :param J: dictionary of couplings.
      :param num_replicas: number of system replicas.
      :param num_pt_steps: number of parallel tempering steps.
      :param num_sweeps: number of Monte Carlo sweeps per parallel tempering step.
      :param beta_min: inverse temperature of the hottest replica.
      :param beta_max: inverse temperature of the coldest replica.
      :returns: single-element sample set with the best solution found.