<commit_before>.. image:: https://travis-ci.org/dwavesystems/dimod.svg?branch=master
    :target: https://travis-ci.org/dwavesystems/dimod

.. image:: https://ci.appveyor.com/api/projects/status/kfhg35q12fa0lux8?svg=true
    :target: https://ci.appveyor.com/project/arcondello/dimod

.. image:: https://coveralls.io/repos/github/dwavesystems/dimod/badge.svg?branch=master
    :target: https://coveralls.io/github/dwavesystems/dimod?branch=master

.. image:: https://readthedocs.org/projects/dimod/badge/?version=latest
    :target: http://dimod.readthedocs.io/en/latest/?badge=latest

.. inclusion-marker-do-not-remove

dimod
=====

A shared API for QUBO/Ising samplers.

Included Samplers
-----------------

dimod comes with a few samplers that are useful as reference implementations and for unit testing.

* SimulatedAnnealingSampler: A reference implementation of a simulated annealing algorithm.
* ExactSolver: determines the energy for every possible sample, but is extremely slow.
* RandomSampler: Generates random samples. Used for testing.

Example Usage
-------------

>>> import dimod<commit_msg>Update appveyor badget to dwave-adtt<commit_after>.. image:: https://travis-ci.org/dwavesystems/dimod.svg?branch=master
    :target: https://travis-ci.org/dwavesystems/dimod

.. image:: https://ci.appveyor.com/api/projects/status/2oc8vrxxh15ecgo1?svg=true
    :target: https://ci.appveyor.com/project/dwave-adtt/dimod

.. image:: https://coveralls.io/repos/github/dwavesystems/dimod/badge.svg?branch=master
    :target: https://coveralls.io/github/dwavesystems/dimod?branch=master

.. image:: https://readthedocs.org/projects/dimod/badge/?version=latest
    :target: http://dimod.readthedocs.io/en/latest/?badge=latest

.. inclusion-marker-do-not-remove

dimod
=====

A shared API for QUBO/Ising samplers.

Included Samplers
-----------------

dimod comes with a few samplers that are useful as reference implementations and for unit testing.

* SimulatedAnnealingSampler: A reference implementation of a simulated annealing algorithm.
* ExactSolver: determines the energy for every possible sample, but is extremely slow.
* RandomSampler: Generates random samples. Used for testing.

Example Usage
-------------

>>> import dimod
{'fraction_non_alphanumeric': 0.14573088958426464, 'fraction_numerical': 0.0049172999552972736, 'mean_word_length': 4.006711409395973, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3765924', 'n_tokens_mistral': 743, 'n_tokens_neox': 707, 'n_words': 153}