-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve the qiskit.algorithms
docs: clearly show legacy vs. primitive algorithms
#9382
Conversation
Emphasize the split in primitive-based and legacy algorithms more clearly
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 3984526255
💛 - Coveralls |
Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I will wait to see the rendered docs before merging, just in case.
I've marked this on hold to preserve the CI bandwidth. We can merge this after rc1 is tagged since it's a bugfix release. After rc1 is tagged lets remove the on hold label |
Ideally we would like people to start using these new ones now (not in the future) for any new code (and maybe even update existing code), as the the legacy ones ones, while they continue to work, will soon be deprecated and later removed. Hence the "In the future, " bit seems like it could be improved (I just quoted one example above). In the future you will only be able to use these. Now you can too and indeed we recommend you do use these rather than the legacy versions. |
That's a good point, how about something like
? |
Looks much better to me thx! |
Done in bf1f6cc 👍🏻 |
…tive algorithms (#9382) * Algorithms init cleanup Emphasize the split in primitive-based and legacy algorithms more clearly * add "pending deprecation" in heading * apply same layout to time evolvers * temporarily pin to get CI done, merge from main later * pin to 1.23.1 * remove "pending deprecation" * add missing TrotterQRTE import * Apply suggestions from code review Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com> * trailing whitespaces * more trailing whitespace -- this time at front * reword Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit e58ac56)
…tive algorithms (#9382) (#9415) * Algorithms init cleanup Emphasize the split in primitive-based and legacy algorithms more clearly * add "pending deprecation" in heading * apply same layout to time evolvers * temporarily pin to get CI done, merge from main later * pin to 1.23.1 * remove "pending deprecation" * add missing TrotterQRTE import * Apply suggestions from code review Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com> * trailing whitespaces * more trailing whitespace -- this time at front * reword Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> (cherry picked from commit e58ac56) Co-authored-by: Julien Gacon <gaconju@gmail.com>
…tive algorithms (Qiskit#9382) * Algorithms init cleanup Emphasize the split in primitive-based and legacy algorithms more clearly * add "pending deprecation" in heading * apply same layout to time evolvers * temporarily pin to get CI done, merge from main later * pin to 1.23.1 * remove "pending deprecation" * add missing TrotterQRTE import * Apply suggestions from code review Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com> * trailing whitespaces * more trailing whitespace -- this time at front * reword Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
…tive algorithms (Qiskit/qiskit#9382) * Algorithms init cleanup Emphasize the split in primitive-based and legacy algorithms more clearly * add "pending deprecation" in heading * apply same layout to time evolvers * temporarily pin to get CI done, merge from main later * pin to 1.23.1 * remove "pending deprecation" * add missing TrotterQRTE import * Apply suggestions from code review Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com> * trailing whitespaces * more trailing whitespace -- this time at front * reword Co-authored-by: ElePT <57907331+ElePT@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Emphasize the split in primitive-based and legacy algorithms more clearly
Summary
More clearly emphasize that for the (minimum) eigensolvers there is currently a duplication of algorithms: the legacy,
QuantumInstance
-based algorithms that are pending deprecation and the new, primitive-based ones.Details and comments
An alternative would be to keep the separate headings and link to the non-deprecated one, like in the screenshot for the time evolvers below. However since the headings are "Eigensolvers" vs. "Eigen Solvers" I think it would be nice to merge them.