dwave-system icon indicating copy to clipboard operation
dwave-system copied to clipboard

DWaveSampler docs for the returned SampleSet

Open arcondello opened this issue 5 years ago • 1 comments

Currently the SampleSet returned by the DWaveSampler contains information in the info field. E.g.

>>> DWaveSampler().sample_ising({0: 0}, {}).info
{'timing': {'total_real_time': 7757,
  'qpu_access_overhead_time': 824,
  'anneal_time_per_run': 20,
  'post_processing_overhead_time': 315,
  'qpu_sampling_time': 164,
  'readout_time_per_run': 123,
  'qpu_delay_time_per_sample': 21,
  'qpu_anneal_time_per_sample': 20,
  'total_post_processing_time': 315,
  'qpu_programming_time': 7593,
  'run_time_chip': 164,
  'qpu_access_time': 7757,
  'qpu_readout_time_per_sample': 123}}

the docs for the DWaveSampler should explain where to find this list. Right now it only contains timing so perhaps should link to timing-related fields?

arcondello avatar Apr 16 '19 15:04 arcondello

The most common occurrence of this for me is the following. I want to access a specific field in a SampleSet returned from sample_qubo. I go to the documentation for sample_qubo (https://docs.ocean.dwavesys.com/projects/dimod/en/latest/reference/generated/dimod.Sampler.sample_qubo.html#dimod.Sampler.sample_qubo) and see that a SampleSet is returned. I click on SampleSet (https://docs.ocean.dwavesys.com/projects/dimod/en/latest/reference/sampleset.html#dimod.SampleSet) and can't find the information I want about accessing the qpu_access_time or any of the other sampler specific fields. I end up running my program and printing out the entire SampleSet object to see what each field is named and what's there, then rerun my program to get that item.

vgoliber avatar Apr 16 '19 16:04 vgoliber