Describe optimization parameters in docs #615
Merged
Conversation
This file contains 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
|
@garrison I went ahead and added some details but they are all in the docstring. I wonder if that is where we want to put it. |
ibrahim-shehzad
added
documentation
Pull Request Test Coverage Report for Build 9356235036Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
garrison
added
the
stable backport potential
It'd be nice to get the descriptions in the "Attributes" table on the page of the sphinx build. If you format the descriptions as comments that start with |
It does (f4a64b0). I did not get it to work with multiple sentences and/or multiple lines wasn't straightforward though so I kept everything in one sentence. |
garrison
reviewed
Jun 3, 2024
Co-authored-by: Jim Garrison <[email protected]>
garrison
reviewed
Jun 12, 2024
| nevertheless returns the result of a greedy best first search, which gives an *upper-bound* on gamma. | ||
| """ | ||
|
|
||
| #: The seed to use when initializing Numpy random number generators in the best first search priority queue. |
There was a problem hiding this comment.
Optional suggestion
Suggested change
| #: The seed to use when initializing Numpy random number generators in the best first search priority queue. | |
| #: The seed to use when initializing Numpy random number generators in the best-first-search priority queue. |
garrison
approved these changes
Jun 12, 2024
mergify bot
pushed a commit
that referenced
this pull request
Jun 12, 2024
* Describe optimization parameters in docs * update docstring * Fix typo in docstring Co-authored-by: Jim Garrison <[email protected]> --------- Co-authored-by: Jim Garrison <[email protected]> (cherry picked from commit d6a8654) # Conflicts: # circuit_knitting/cutting/automated_cut_finding.py
garrison
added a commit
that referenced
this pull request
Jun 13, 2024
* Describe optimization parameters in docs (#615) * Describe optimization parameters in docs * update docstring * Fix typo in docstring Co-authored-by: Jim Garrison <[email protected]> --------- Co-authored-by: Jim Garrison <[email protected]> (cherry picked from commit d6a8654) # Conflicts: # circuit_knitting/cutting/automated_cut_finding.py * Resolve conflict --------- Co-authored-by: Ibrahim Shehzad <[email protected]> Co-authored-by: Jim Garrison <[email protected]>
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.
Add explanation for the fields in
OptimizationParameters, in particularmax_gammaandmax_backjumps.