dwavesystems / dimod

A shared API for QUBO/Ising samplers.
https://docs.ocean.dwavesys.com/en/stable/docs_dimod/
Apache License 2.0
122 stars 81 forks source link

Sampler.sample_qubo should explicitly call out that non-unique interactions are added #493

Open arcondello opened 5 years ago

arcondello commented 5 years ago

Application In Ocean, Q = {('a', 'b'): -1, ('b', 'a'): 1} is equivalent to Q = {('a', 'b'): 0}. In the BQM-as-polynomial formulation this is (hopefully) clear.

However, for those users who are used to thinking of QUBOs as matrices, a common point of confusion is whether the matrix should be upper-triangular or symmetric, and whether the biases are added, ignored or treated separately.

Proposed Solution In the docstring for the BQM, we call out the addition explicitly. We should also add this to the docstring for Sampler.sample_qubo.

Additional Context There may be other places in the documentation that we should call this out. @vgoliber

vgoliber commented 5 years ago

Other places where this could be addressed: