Skip to content

Latest commit

 

History

History
203 lines (131 loc) · 3.29 KB

samplers.rst

File metadata and controls

203 lines (131 loc) · 3.29 KB

Samplers

The dimod package includes several example samplers.

Other Ocean packages provide production samplers; for example, the :std:doc:`dwave-system <oceandocs:docs_system/sdk_index>` package provides :std:doc:`samplers for D-Wave systems <oceandocs:docs_system/reference/samplers>` and :std:doc:`dwave-neal <oceandocs:docs_neal/sdk_index>` provides a simulated-annealing sampler.

.. automodule:: dimod.reference.samplers

.. currentmodule:: dimod.reference.samplers

Exact Solver

A simple exact solver for testing and debugging code using your local CPU.

Note:
This sampler is designed for use in testing. Because it calculates the energy for every possible sample, it is very slow.

Class

.. autoclass:: ExactSolver

Methods

.. autosummary::
   :toctree: ../generated/

   ExactSolver.sample
   ExactSolver.sample_ising
   ExactSolver.sample_qubo

Exact DQM Solver

A simple DQM exact solver for testing and debugging code using your local CPU.

Note:
This sampler is designed for use in testing. Because it calculates the energy for every possible sample, it is very slow.

Class

.. autoclass:: ExactDQMSolver

Methods

.. autosummary::
   :toctree: ../generated/

   ExactDQMSolver.sample_dqm

Exact CQM Solver

A simple CQM exact solver for testing and debugging code using your local CPU.

Note:
This sampler is designed for use in testing. Because it calculates the energy and constraint violations for every possible sample, it is very slow.

Class

.. autoclass:: ExactCQMSolver

Methods

.. autosummary::
   :toctree: ../generated/

   ExactCQMSolver.sample_cqm

Identity Sampler

.. automodule:: dimod.reference.samplers.identity_sampler

Class

.. autoclass:: IdentitySampler

Properties

.. autosummary::
   :toctree: ../generated/

   IdentitySampler.parameters

Methods

.. autosummary::
   :toctree: ../generated/

   IdentitySampler.sample
   IdentitySampler.sample_ising
   IdentitySampler.sample_qubo

Null Sampler

.. automodule:: dimod.reference.samplers.null_sampler

Class

.. autoclass:: NullSampler

Properties

.. autosummary::
   :toctree: ../generated/

   NullSampler.parameters

Methods

.. autosummary::
   :toctree: ../generated/

   NullSampler.sample
   NullSampler.sample_ising
   NullSampler.sample_qubo

Random Sampler

.. automodule:: dimod.reference.samplers.random_sampler

Class

.. autoclass:: RandomSampler

Properties

.. autosummary::
   :toctree: ../generated/

   RandomSampler.parameters

Methods

.. autosummary::
   :toctree: ../generated/

   RandomSampler.sample
   RandomSampler.sample_ising
   RandomSampler.sample_qubo

Simulated Annealing Sampler

.. automodule:: dimod.reference.samplers.simulated_annealing

Class

.. autoclass:: SimulatedAnnealingSampler

Properties

.. autosummary::
   :toctree: ../generated/

   SimulatedAnnealingSampler.parameters

Methods

.. autosummary::
   :toctree: ../generated/

   SimulatedAnnealingSampler.sample
   SimulatedAnnealingSampler.sample_ising
   SimulatedAnnealingSampler.sample_qubo