Add problem info to the NL sampler result #565
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`info` field is a dict that includes timing info, and warnings pulled out of the timing.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #565 +/- ##
==========================================
- Coverage 88.88% 86.08% -2.81%
==========================================
Files 21 21
Lines 1809 1818 +9
==========================================
- Hits 1608 1565 -43
- Misses 201 253 +52 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Joel Pasvolsky <[email protected]>
arcondello
approved these changes
Apr 8, 2025
| @@ -918,7 +918,7 @@ def parameters(self) -> Dict[str, List[str]]: | |||
|
|
|||
| class SampleResult(NamedTuple): | |||
| model: dwave.optimization.Model | |||
| timing: dict | |||
| info: dict | |||
There was a problem hiding this comment.
I suppose we could say
info: dict[str, typing.Any]might be overkill but 🤷
Even more overkill would be to use typing.Literal.
JoelPasvolsky
approved these changes
Apr 8, 2025
randomir
deleted the
feature/add-problem-info-to-nl-sampler-result/issue-528
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #528.
Opted for the second option from #528, renaming
timingtoinfoand adding general problem info there, together with timing info and warnings.The
infofield returned inLeapHybridNLSampler.SampleResultnamed tuple is adict, now consistent withSampleSet.info, e.g.:{ "timing": {...}, "warnings": [...], "problem_id": "...", "problem_label": "...", "problem_data_id": "..." }This change is technically breaking backwards-compatibility, but given that:
LeapHybridNLSampler.sample()hasn't been documented in full (name of thetimingfield is not specified),I think we should be OK making this change.