Qiskit / qiskit / 7225037636

88%

Build Type

push

github

Committed by web-flow

Commit Message

Document how to use high level synthesis plugins (#11389)

* Document how to use high level synthesis plugins

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 #11356

* Add missing import

* Apply suggestions from code review

Co-authored-by: Kevin J. Sung <kevinjefferysung@gmail.com>

* Update qiskit/transpiler/passes/synthesis/plugin.py

Co-authored-by: Kevin J. Sung <kevinjefferysung@gmail.com>

* Fix excessive line length

* Add comment on meaning of keyword arguments

* Rework HLSConfig documentation listing

---------

Co-authored-by: Kevin J. Sung <kevinjefferysung@gmail.com>
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>

Run Details

3 of 5 new or added lines in 2 files covered. (60.0%)

20 existing lines in 3 files now uncovered.

59140 of 67592 relevant lines covered (87.5%)

282206.85 hits per line