-
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
Document how to use high level synthesis plugins #11389
Conversation
This commit adds missing documentation to the transpiler synthesis plugin page on how to use the high level synthesis plugin interface. There was existing documentation on how to write a high level synthesis plugin but not for how users can consume any installed plugins. This commit fills that documentation gap and also adds the HLSConfig class to the documentation as a stable defined interface. This was an oversight as we've not been treating the API interface as stable as it's the primary entrypoint for using high level synthesis plugins. Additionally, a new function high_level_synthesis_plugin_names is added in this PR to make querying the installed plugins a bit easier as to do this before you had to instantiate a plugin manager object to do this. This makes the querying interface similar to what exists for unitary synthesis. Fixes Qiskit#11356
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 7213117378Warning: This coverage report may be inaccurate.We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
💛 - Coveralls |
Co-authored-by: Kevin J. Sung <[email protected]>
Co-authored-by: Kevin J. Sung <[email protected]>
I'll take over the last few changes needed for this on Matt's behalf, since he's on holiday now and I'd like to get the documentation whole plugged sooner rather than later. Let me know if there's anything more that needs changing, and I can do it. |
Thanks, it's pretty clear now. Now the documentation here is clearer than in the docstring of HLSConfig. How about we add a link in that docstring to this documentation? |
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 with just one comment about improving the docstring of HLSConfig itself
Sure, I've tried to make |
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.
Thanks!
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.
(proxying approval)
Summary
This commit adds missing documentation to the transpiler synthesis plugin page on how to use the high level synthesis plugin interface. There was existing documentation on how to write a high level synthesis plugin but not for how users can consume any installed plugins. This commit fills that documentation gap and also adds the HLSConfig class to the documentation as a stable defined interface. This was an oversight as we've not been treating the API interface as stable as it's the primary entrypoint for using high level synthesis plugins. Additionally, a new function high_level_synthesis_plugin_names is added in this PR to make querying the installed plugins a bit easier as to do this before you had to instantiate a plugin manager object to do this. This makes the querying interface similar to what exists for unitary synthesis.
Details and comments
Fixes #11356
Fixes Qiskit/documentation#505