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

Improve transpiler documentation (backport #9087) #9469

Merged
merged 1 commit into from
Jan 26, 2023

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jan 26, 2023

This is an automatic backport of pull request #9087 done by Mergify.


Mergify commands and options

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

  • @Mergifyio refresh will re-evaluate the rules
  • @Mergifyio rebase will rebase this PR on its base branch
  • @Mergifyio update will merge the base branch into this PR
  • @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

  • look at your merge queues
  • generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com

* Improve transpiler documentation

This commit expands the module documentation for the qiskit.transpiler
module to explain details of working with preset pass managers and how
to modify stages for custom workflows. It also updates some of the
details about the stages which were a bit stale on the exact behavior of
the transpiler.

* Apply suggestions from code review

Co-authored-by: Jake Lishman <[email protected]>

* More refactors from code review

* Update reference label for stages section

* Add section headers to scheduling stage docs

* Fix lint

* Fix typo

* Update examples to show stochastic passes

* Fix rebase typos and example issues

* Update qiskit/transpiler/__init__.py

* Apply suggestions from code review

Co-authored-by: Kevin Krsulich <[email protected]>

* Fix trailing whitespace

* Expand init stage definition

* Apply suggestions from code review

Co-authored-by: Kevin Krsulich <[email protected]>

* Simplify target section intro

* Highlight legacy views are for backwards compatibility

* Updating layout and routing for extra details

* Apply suggestions from code review

Co-authored-by: Kevin Hartman <[email protected]>

* Update qiskit/transpiler/preset_passmanagers/__init__.py

Co-authored-by: Kevin Hartman <[email protected]>

* More updates from code review

* Fix line length lint failure

* Apply suggestions from code review

Co-authored-by: Kevin Krsulich <[email protected]>

* Expand sabre layout explanation

* Explain pass description in stage details header

Co-authored-by: Jake Lishman <[email protected]>
Co-authored-by: Kevin Krsulich <[email protected]>
Co-authored-by: Kevin Hartman <[email protected]>
(cherry picked from commit 925f9f3)
@mergify mergify bot requested a review from a team as a code owner January 26, 2023 15:15
@qiskit-bot
Copy link
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

  • @Qiskit/terra-core

@mtreinish mtreinish added automerge Changelog: None Do not include in changelog labels Jan 26, 2023
@mergify mergify bot merged commit 25b5357 into stable/0.23 Jan 26, 2023
@mergify mergify bot deleted the mergify/bp/stable/0.23/pr-9087 branch January 26, 2023 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants