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

Fix up docstring for VF2PostLayout #9027

Merged
merged 2 commits into from
Oct 31, 2022

Conversation

mtreinish
Copy link
Member

Summary

This commit fixes a few copy paste errors and errors in the docstring for the VF2PostLayout pass. It also adds a a link to the paper for the pass.

Details and comments

This was originally part of #9026 as these fixes were part of modifying the docstring to document the new feature being added in that PR. This commit just extracts those docstring fixes from that PR.

This commit fixes a few copy paste errors and errors in the docstring
for the VF2PostLayout pass. It also adds a a link to the paper for the
pass.

This was originally part of Qiskit#9026 as these fixes were part of modifying
the docstring to document the new feature being added in that PR. This
commit just extracts those docstring fixes from that PR.
@mtreinish mtreinish added documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable Changelog: None Do not include in changelog labels Oct 28, 2022
@mtreinish mtreinish added this to the 0.22.1 milestone Oct 28, 2022
@mtreinish mtreinish requested a review from a team as a code owner October 28, 2022 19:13
@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

@coveralls
Copy link

coveralls commented Oct 28, 2022

Pull Request Test Coverage Report for Build 3365163210

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 84.456%

Totals Coverage Status
Change from base Build 3362984978: 0.0%
Covered Lines: 62192
Relevant Lines: 73638

💛 - Coveralls

further swap mapping or routing is needed. If a solution is found the layout
will be set in the property set as ``property_set['layout']``. However, if no
solution is found, no ``property_set['layout']`` is set. The stopping reason is
If a solution is found that means there is a lower error layout available for the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If a solution is found that means there is a lower error layout available for the
If a solution is found that means there is a low error layout available for the

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is actually better as is. The VF2PostLayout pass is searching for a lower estimate error rate subgraph than the current layout. It's not guaranteed to find a low error rate in general it actually could still be quite high it's just relative to the input layout when the pass is run.

Copy link
Member

@1ucian0 1ucian0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment on a comparative without a counter part (lower than what?).

@mtreinish mtreinish removed this from the 0.22.1 milestone Oct 31, 2022
@mergify mergify bot merged commit 234816c into Qiskit:main Oct 31, 2022
mergify bot pushed a commit that referenced this pull request Oct 31, 2022
This commit fixes a few copy paste errors and errors in the docstring
for the VF2PostLayout pass. It also adds a a link to the paper for the
pass.

This was originally part of #9026 as these fixes were part of modifying
the docstring to document the new feature being added in that PR. This
commit just extracts those docstring fixes from that PR.

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 234816c)
mergify bot added a commit that referenced this pull request Nov 1, 2022
This commit fixes a few copy paste errors and errors in the docstring
for the VF2PostLayout pass. It also adds a a link to the paper for the
pass.

This was originally part of #9026 as these fixes were part of modifying
the docstring to document the new feature being added in that PR. This
commit just extracts those docstring fixes from that PR.

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 234816c)

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
@mtreinish mtreinish deleted the fix-vf2-post-layout-docs branch November 1, 2022 21: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 documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants