Document generate_preset_pass_manager supports list for initial_layout #12214
Conversation
This file contains 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
This commit updates the documentation for the generate_preset_pass_manager() function to clearly indicate that the function will accept a integer list for the initial_layout field. This already was supported but it wasn't documented. As it's now a documented part of the API a unittest is added to ensure we don't regress this functionality in the future. Fixes Qiskit#11690
mtreinish
added
documentation
|
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 8744705876Details
💛 - Coveralls |
jakelishman
approved these changes
Apr 18, 2024
| tqc_obj = pm_list.run(qc) | ||
| self.assertIsInstance(pm_list, PassManager) | ||
| self.assertIsInstance(pm_object, PassManager) | ||
| self.assertEqual(tqc_list, tqc_obj) |
There was a problem hiding this comment.
We don't actually formally compare layouts in QuantumCircuit.__eq__ because we immediately convert to DAGCircuit, which doesn't have a layout field, but we do compare qubit positions, so this should be a fine test.
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
This commit updates the documentation for the
generate_preset_pass_manager() function to clearly indicate that the function will accept a integer list for the initial_layout field. This already was supported but it wasn't documented. As it's now a documented part of the API a unittest is added to ensure we don't regress this functionality in the future.
Details and comments
Fixes #11690