Split PyDAGCircuit and DAGCircuit#16471
Open
raynelfss wants to merge 13 commits into
Open
Conversation
The following commit splits the representations of `DAGCircuit` into: - `DAGCircuit` representing the rust-native implementation of the `DAG` excluding its metadata. - `PyDAGCircuit` the version that gets exposed to Python. `PyDAGCircuit` does not implement `Deref<DAGCircuit>` due to future plans requiring us to implement a reference counted `Circuit` for the Python version of the DAG.
The following commits make sure we preserve the metadata of the `DAGCircuit` in passes where the instance is copied. This includes: - `CommutativeOptimization` - `ConvertToPauliRotations` - `DisjointLayout` - `ElidePermutations` - `LitinskiTransformation` - `Split2QUnitaries` - `TwoQubitPeepholeOptimization` - `BasisTranslator` - `SabreLayout` - `SabreRouting` - `UnitarySynthesis`
This commit moves the `name` attribute to exist only within `PyDAGCircuit` since it is Python exclusive metadata. This commit also adds constructors with metadata from other `PyDAGCircuit` instances and a `DAGCircuit` from rust: - `from_dagcircuit` which also accepts optional `metadata` and `name`. - `from_dagcircuit_with_cloned_metadata` which accepts a reference to the `PyDAGCircuit` and copies over the attributes for the user. The transpiler passes that don't perform transformations in place have been updated to use this model.
raynelfss
changed the title
PyDAGCircuit and DAGCircuitPyDAGCircuit and DAGCircuit
raynelfss
added
Changelog: Changed
Collaborator
|
One or more of the following people are relevant to this code:
|
Some auxiliary methods would need to immutably or mutably obtain the dag and therefore should only remain as auxiliary methods to the `DAGCircuit` instead of the `PyDAGCircuit` instance.
The methods will now be called `try_read` and `try_write` and are fallible. This commit refactors the methods and updates their usage.
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
2 participants
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.
Partially fixes #15575
The following commits splits the representations of
DAGCircuitinto:DAGCircuitrepresenting the rust-native implementation of theDAGexcluding its metadata.PyDAGCircuitthe version that gets exposed to Python.PyDAGCircuitdoes not implementDeref<DAGCircuit>due to future plans requiring us to implement a reference countedCircuitfor the Python version of the DAG.The PR also applies changes to any and all transpiler passes working in Rust, as well as the C-API functions that operate at the Python level.
The changes on this PR are extensive and intrusive. So, as a reviewer, I'd suggest focusing on the changes in the
qiskit/crates/circuit/src/dag_circuit.rsmainly as this is where the bulk of these changes exist. Review the rest of the items after we have reached a consensus as the changes in those files are much smaller.Behavior changes
Control flow
DAGCircuitblocks will no longer retain their metadata (which includes theDAGCircuit.nameattribute) because these are Python only attributes and blocks are stored as their rust-native structs. Usage of metadata withinControlFlowblocks was never supported and users should upgrade their workflows if they were using metadata in this context.AI/LLM disclosure