search

dwavesystems / dwave-neal

An implementation of a simulated annealing sampler for general Ising model graphs in C++ with a dimod Python wrapper.
https://docs.ocean.dwavesys.com/projects/neal/en/latest
Apache License 2.0
51 stars 45 forks source link

SimulatedAnnealingSampler.sample method return type incorrectly documented #107

Closed CrashAndSideburns closed 1 year ago

CrashAndSideburns commented 2 years ago

Description The return type of the SimulatedAnnealingSampler.sample method is said to be "a dimod Response object" in the docs, a class which is nowhere documented in the neal or dimod docs.

To Reproduce View here.

Expected Behaviour The documentation should be changed to reflect that actual return type of SimulatedAnnealingSampler.sample, namely SampleSet.

Environment: N/A

arcondello commented 2 years ago

Agree! Thanks for the bug report!

randomir commented 1 year ago

Fixed.