Skip to content

dwavesystems/dwave-neal

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

Corrected errors in beta_range defaults, simplified discretization pf schedule, added documentation, and beta_schedule parameter
0457d05

Git stats

Files

Permalink
Failed to load latest commit information.
https://readthedocs.com/projects/d-wave-systems-dwave-neal/badge/?version=latest https://circleci.com/gh/dwavesystems/dwave-neal.svg?style=svg

dwave-neal

An implementation of a simulated annealing sampler.

A simulated annealing sampler can be used for approximate Boltzmann sampling or heuristic optimization. This implementation approaches the equilibrium distribution by performing updates at a sequence of increasing beta values, beta_schedule, terminating at the target beta. Each spin is updated once in a fixed order per point in the beta_schedule according to a Metropolis- Hastings update. When beta is large the target distribution concentrates, at equilibrium, over ground states of the model. Samples are guaranteed to match the equilibrium for long 'smooth' beta schedules.

For more information, see Kirkpatrick, S.; Gelatt Jr, C. D.; Vecchi, M. P. (1983). "Optimization by Simulated Annealing". Science. 220 (4598): 671–680

Example Usage

import neal

sampler = neal.SimulatedAnnealingSampler()

h = {0: -1, 1: -1}
J = {(0, 1): -1}
sampleset = sampler.sample_ising(h, J)

Installation

To install:

pip install dwave-neal

To build from source:

pip install -r requirements.txt
python setup.py build_ext --inplace
python setup.py install

License

Released under the Apache License 2.0. See LICENSE file.

Contributing

Ocean's contributing guide has guidelines for contributing to Ocean packages.

About

An implementation of a simulated annealing sampler for general Ising model graphs in C++ with a dimod Python wrapper.

Resources

License

Stars

Watchers

Forks

Packages

No packages published