Skip to content
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

Add API docs section for synthesis plugins post-1.0.0rc1 #11675

Closed
mtreinish opened this issue Jan 30, 2024 · 3 comments · Fixed by #11763
Closed

Add API docs section for synthesis plugins post-1.0.0rc1 #11675

mtreinish opened this issue Jan 30, 2024 · 3 comments · Fixed by #11763
Assignees
Labels
documentation Something is not clear or an error documentation
Milestone

Comments

@mtreinish
Copy link
Member

What should we add?

We should have a dedicated page in the api docs that enumerate all the built-in transpiler synthesis plugins. These should list the plugin name and the details of all the plugins. Right now we only have this page:

https://github.com/Qiskit/qiskit/blob/main/docs/apidoc/transpiler_builtin_plugins.rst

which only lists aqc.

This was attempted in #10657 but was removed from that PR because it was larger scope than just adding that method. What was attempted in that PR was to use the class docstrings for the plugin classes. The issue with that though is that the plugin method interface isn't actually the class, but instead is the plugin name. It was a bit awkward to link to all the classes in the documentation but say the interface being documented isn't the thing you should use, that link just contains the details of some other interface not explicitly documented.

We should try to include this in the final 1.0.0 release, as it's only documentation changes we can do this post-rc1 as it won't change any interfaces being released.

@mtreinish mtreinish added the type: feature request New feature or request label Jan 30, 2024
@mtreinish mtreinish added this to the 1.0.0 milestone Jan 30, 2024
@mtreinish mtreinish added documentation Something is not clear or an error documentation and removed type: feature request New feature or request labels Feb 1, 2024
@kevinsung
Copy link
Contributor

It appears that #11763 only added documentation for the aqc unitary synthesis plugin, but not the default and sk plugins. Am I missing something? How do I find the documentation for the default unitary synthesis plugin?

@ShellyGarion
Copy link
Member

It appears that #11763 only added documentation for the aqc unitary synthesis plugin, but not the default and sk plugins. Am I missing something? How do I find the documentation for the default unitary synthesis plugin?

You can find all unitary synthesis plugins here: https://docs.quantum.ibm.com/api/qiskit/transpiler_synthesis_plugins#unitary-synthesis-plugins-2

The Solovay-Kitaev plugin is here: https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis

The default unitary plugin is here: https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis

@kevinsung
Copy link
Contributor

It appears that #11763 only added documentation for the aqc unitary synthesis plugin, but not the default and sk plugins. Am I missing something? How do I find the documentation for the default unitary synthesis plugin?

You can find all unitary synthesis plugins here: https://docs.quantum.ibm.com/api/qiskit/transpiler_synthesis_plugins#unitary-synthesis-plugins-2

The Solovay-Kitaev plugin is here: https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.passes.synthesis.solovay_kitaev_synthesis.SolovayKitaevSynthesis

The default unitary plugin is here: https://docs.quantum.ibm.com/api/qiskit/qiskit.transpiler.passes.synthesis.unitary_synthesis.DefaultUnitarySynthesis

This is what I was looking for, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or an error documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants