-
Notifications
You must be signed in to change notification settings - Fork 109
DAGCircuit is missing adequate documentation #1431
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
Comments
Hi @sbrandhsn, thanks for opening the issue. Does the unitary synthesis plugin example in the the "Create a transpiler plugin" page help at all? It's the only other place where I see Marking this as needs discussion so our team can assess next steps. |
@sbrandhsn can you specify the material from the tutorial you'd like to see added into the docs? |
I believe sections 'Introducing the DAG' and 'Implementing a BasicMapper Pass' would be helpful. Longterm, I think 'Introducing the DAG' can be extended heavily to highlight any new functionality in |
I agree, I think the content we currently have on DAG stuff could be expanded into it's own page. |
Interested in trying this one for unitaryHACK. |
Hi @Eric-Arellano and @sbrandhsn made a PR addressing the issue with the latest version of qiskit 2.0 |
I am interested in the issue as well |
Hi @JGeipel, @AbdullahKazi500, @SecludedPerson700 . Thanks for you interest in working on this for the Unitary Hack! I'll go through and review each of these PRs in submission order. |
Thanks |
👋 This issue is part of UnitaryHack 2025. For the duration of the event, it follows a few special rules and considerations:
Happy hacking! 🧑💻✨ |
URL to the relevant documentation
A
DAGCircuit
(https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuit) is an essential part of the transpilation backbone.Formerly, we had the tutorial at https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/circuits_advanced/04_transpiler_passes_and_passmanager.ipynb to describe how to work with a
DAGCircuit
but nowadays there is no information on that except what is included in the API docs at https://docs.quantum.ibm.com/api/qiskit/qiskit.dagcircuit.DAGCircuitSpecifically, https://docs.quantum.ibm.com/transpile/custom-transpiler-pass points to https://www.rustworkx.org/tutorial/dags.html which is not as useful as the previously available tutorial for users that want to develop their own passes.
Select all that apply
Describe the fix.
Insert a subset of the content at https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/circuits_advanced/04_transpiler_passes_and_passmanager.ipynb into the docs or add a new section that describes how to work with the
DAGCircuit
to users that want to develop their own passes.The text was updated successfully, but these errors were encountered: