Document transpiler pass categories and examples#16403
Open
kataro92 wants to merge 3 commits into
Open
Conversation
Add an overview of analysis and transformation passes, explain the role of each pass category, and include small examples for using passes with PassManager.
Coverage Report for CI Build 27249783085Coverage decreased (-0.01%) to 87.531%Details
Uncovered ChangesNo uncovered changes found. Coverage Regressions27 previously-covered lines in 4 files lost coverage.
Coverage Stats
💛 - Coveralls |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #3436.
This expands the
qiskit.transpiler.passesAPI documentation with a short guide to using transpiler passes directly. It explains how passes work withPassManager, the difference between analysis and transformation passes, and how the pass categories fit into a custom transpilation workflow.Details and comments
The current
docs/apidoc/transpiler_passes.rstpage renders the module docstring fromqiskit.transpiler.passes, so this PR updatesqiskit/transpiler/passes/__init__.py.The new documentation:
AnalysisPass,TransformationPass, andPropertySet.CountOps,RemoveBarriers, andInverseCancellationwithPassManager.This keeps the change scoped to the transpiler-passes API page and avoids duplicating the broader preset-pass-manager overview from
qiskit.transpiler.Tests
python -m py_compile qiskit/transpiler/passes/__init__.pygit diff --checkAI/LLM disclosure
I reviewed and understand the generated guidance, documentation change, examples, and test results before submitting.