From 05f64295ed8ab55a729cb0f81ff9662201e6f5e5 Mon Sep 17 00:00:00 2001 From: Sebastian Brandhofer <148463728+sbrandhsn@users.noreply.github.com> Date: Wed, 4 Sep 2024 20:21:25 +0200 Subject: [PATCH] Oxidize Commutation Analysis (#12995) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * init * up * lint * . * up * before cache * with cache * correct * cleaned up * lint reno * Update Cargo.lock * . * up * . * revert op * . * . * . * . * Delete Cargo.lock * . * corrected string comparison * removed Operator class from operation.rs * . * Apply suggestions from code review Co-authored-by: Raynel Sanchez <87539502+raynelfss@users.noreply.github.com> * comments from code review * Port DAGCircuit to Rust This commit migrates the entirety of the `DAGCircuit` class to Rust. It fully replaces the Python version of the class. The primary advantage of this migration is moving from a Python space rustworkx directed graph representation to a Rust space petgraph (the upstream library for rustworkx) directed graph. Moving the graph data structure to rust enables us to directly interact with the DAG directly from transpiler passes in Rust in the future. This will enable a significant speed-up in those transpiler passes. Additionally, this should also improve the memory footprint as the DAGCircuit no longer stores `DAGNode` instances, and instead stores a lighter enum NodeType, which simply contains a `PackedInstruction` or the wire objects directly. Internally, the new Rust-based `DAGCircuit` uses a `petgraph::StableGraph` with node weights of type `NodeType` and edge weights of type `Wire`. The NodeType enum contains variants for `QubitIn`, `QubitOut`, `ClbitIn`, `ClbitOut`, and `Operation`, which should save us from all of the `isinstance` checking previously needed when working with `DAGNode` Python instances. The `Wire` enum contains variants `Qubit`, `Clbit`, and `Var`. As the full Qiskit data model is not rust-native at this point while all the class code in the `DAGCircuit` exists in Rust now, there are still sections that rely on Python or actively run Python code via Rust to function. These typically involve anything that uses `condition`, control flow, classical vars, calibrations, bit/register manipulation, etc. In the future as we either migrate this functionality to Rust or deprecate and remove it this can be updated in place to avoid the use of Python. API access from Python-space remains in terms of `DAGNode` instances to maintain API compatibility with the Python implementation. However, internally, we convert to and deal in terms of NodeType. When the user requests a particular node via lookup or iteration, we inflate an ephemeral `DAGNode` based on the internal `NodeType` and give them that. This is very similar to what was done in #10827 when porting CircuitData to Rust. As part of this porting there are a few small differences to keep in mind with the new Rust implementation of DAGCircuit. The first is that the topological ordering is slightly different with the new DAGCircuit. Previously, the Python version of `DAGCircuit` using a lexicographical topological sort key which was basically `"0,1,0,2"` where the first `0,1` are qargs on qubit indices `0,1` for nodes and `0,2` are cargs on clbit indices `0,2`. However, the sort key has now changed to be `(&[Qubit(0), Qubit(1)], &[Clbit(0), Clbit(2)])` in rust in this case which for the most part should behave identically, but there are some edge cases that will appear where the sort order is different. It will always be a valid topological ordering as the lexicographical key is used as a tie breaker when generating a topological sort. But if you're relaying on the exact same sort order there will be differences after this PR. The second is that a lot of undocumented functionality in the DAGCircuit which previously worked because of Python's implicit support for interacting with data structures is no longer functional. For example, previously the `DAGCircuit.qubits` list could be set directly (as the circuit visualizers previously did), but this was never documented as supported (and would corrupt the DAGCircuit). Any functionality like this we'd have to explicit include in the Rust implementation and as they were not included in the documented public API this PR opted to remove the vast majority of this type of functionality. The last related thing might require future work to mitigate is that this PR breaks the linkage between `DAGNode` and the underlying `DAGCirucit` object. In the Python implementation the `DAGNode` objects were stored directly in the `DAGCircuit` and when an API method returned a `DAGNode` from the DAG it was a shared reference to the underlying object in the `DAGCircuit`. This meant if you mutated the `DAGNode` it would be reflected in the `DAGCircuit`. This was not always a sound usage of the API as the `DAGCircuit` was implicitly caching many attributes of the DAG and you should always be using the `DAGCircuit` API to mutate any nodes to prevent any corruption of the `DAGCircuit`. However, now as the underlying data store for nodes in the DAG are no longer the python space objects returned by `DAGCircuit` methods mutating a `DAGNode` will not make any change in the underlying `DAGCircuit`. This can come as quite the surprise at first, especially if you were relying on this side effect, even if it was unsound. It's also worth noting that 2 large pieces of functionality from rustworkx are included in this PR. These are the new files `rustworkx_core_vnext` and `dot_utils` which are rustworkx's VF2 implementation and its dot file generation. As there was not a rust interface exposed for this functionality from rustworkx-core there was no way to use these functions in rustworkx. Until these interfaces added to rustworkx-core in future releases we'll have to keep these local copies. The vf2 implementation is in progress in Qiskit/rustworkx#1235, but `dot_utils` might make sense to keep around longer term as it is slightly modified from the upstream rustworkx implementation to directly interface with `DAGCircuit` instead of a generic graph. Co-authored-by: Matthew Treinish Co-authored-by: Raynel Sanchez <87539502+raynelfss@users.noreply.github.com> Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> Co-authored-by: Alexander Ivrii Co-authored-by: Eli Arbel <46826214+eliarbel@users.noreply.github.com> Co-authored-by: John Lapeyre Co-authored-by: Jake Lishman * Update visual mpl circuit drawer references Right now there is a bug in the matplotlib circuit visualizer likely caused by the new `__eq__` implementation for `DAGOpNode` that didn't exist before were some gates are missing from the visualization. In the interest of unblocking this PR this commit updates the references for these cases temporarily until this issue is fixed. * Ensure DAGNode.sort_key is always a string Previously the sort_key attribute of the Python space DAGCircuit was incorrectly being set to `None` for rust generated node objects. This was done as for the default path the sort key is determined from the rust domain's representation of qubits and there is no analogous data in the Python object. However, this was indavertandly a breaking API change as sort_key is expected to always be a string. This commit adds a default string to use for all node types so that we always have a reasonable value that matches the typing of the class. A future step is likely to add back the `dag` kwarg to the node types and generate the string on the fly from the rust space data. * Make Python argument first in Param::eq and Param::is_close The standard function signature convention for functions that take a `py: Python` argument is to make the Python argument the first (or second after `&self`). The `Param::eq` and `Param::is_close` methods were not following this convention and had `py` as a later argument in the signature. This commit corrects the oversight. * Fix merge conflict with #12943 With the recent merge with main we pulled in #12943 which conflicted with the rust space API changes made in this PR branch. This commit updates the usage to conform with the new interface introduced in this PR. * Add release notes and test for invalid args on apply methods This commit adds several release notes to document this change. This includes a feature note to describe the high level change and the user facing benefit (mainly reduced memory consumption for DAGCircuits), two upgrade notes to document the differences with shared references caused by the new data structure, and a fix note documenting the fix for how qargs and cargs are handled on `.apply_operation_back()` and `.apply_operation_front()`. Along with the fix note a new unit test is added to serve as a regression test so that we don't accidentally allow adding cargs as qargs and vice versa in the future. * Restore `inplace` argument functionality for substitute_node() This commit restores the functionality of the `inplace` argument for `substitute_node()` and restores the tests validating the object identity when using the flag. This flag was originally excluded from the implementation because the Rust representation of the dag is not a shared reference with Python space and the flag doesn't really mean the same thing as there is always a second copy of the data for Python space now. The implementation here is cheating slighty as we're passed in the DAG node by reference it relies on that reference to update the input node at the same time we update the dag. Unlike the previous Python implementation where we were updating the node in place and the `inplace` argument was slightly faster because everything was done by reference. The rust space data is still a compressed copy of the data we return to Python so the `inplace` flag will be slightly more inefficient as we need to copy to update the Python space representation in addition to the rust version. * Revert needless dict() cast on metadata in dag_to_circuit() This commit removes an unecessary `dict()` cast on the `dag.metadata` when setting it on `QuantumCircuit.metadata` in `qiskit.converters.dag_to_circuit()`. This slipped in at some point during the development of this PR and it's not clear why, but it isn't needed so this removes it. * Add code comment for DAGOpNode.__eq__ parameter checking This commit adds a small inline code comment to make it clear why we skip parameter comparisons in DAGOpNode.__eq__ for python ops. It might not be clear why the value is hard coded to `true` in this case, as this check is done via Python so we don't need to duplicate it in rust space. * Raise a ValueError on DAGNode creation with invalid index This commit adds error checking to the DAGNode constructor to raise a PyValueError if the input index is not valid (any index < -1). Previously this would have panicked instead of raising a user catchable error. * Use macro argument to set python getter/setter name This commit updates the function names for `get__node_id` and `set__node_id` method to use a name that clippy is happy with and leverage the pyo3 macros to set the python space name correctly instead of using the implicit naming rules. * Remove Ord and PartialOrd derives from interner::Index The Ord and PartialOrd traits were originally added to the Index struct so they could be used for the sort key in lexicographical topological sorting. However, that approach was abandonded during the development of this PR and instead the expanded Qubit and Clbit indices were used instead. This left the ordering traits as unnecessary on Index and potentially misleading. This commit just opts to remove them as they're not needed anymore. * Fix missing nodes in matplotlib drawer. Previously, the change in equality for DAGNodes was causing nodes to clobber eachother in the matplotlib drawer's tracking data structures when used as keys to maps. To fix this, we ensure that all nodes have a unique ID across layers before constructing the matplotlib drawer. They actually of course _do_ in the original DAG, but we don't really care what the original IDs are, so we just make them up. Writing to _node_id on a DAGNode may seem odd, but it exists in the old Python API (prior to being ported to Rust) and doesn't actually mutate the DAG at all since DAGNodes are ephemeral. * Revert "Update visual mpl circuit drawer references" With the previous commit the bug in the matplotlib drawer causing the images to diverge should be fixed. This commit reverts the change to the reference images as there should be no difference now. This reverts commit 1e4e6f386286b0b4e7f3ebd3f706f948dd707575. * Update visual mpl circuit drawer references for control flow circuits The earlier commit that "fixed" the drawers corrected the visualization to match expectations in most cases. However after restoring the references to what's on main several comparison tests with control flow in the circuit were still failing. The failure mode looks similar to the other cases, but across control flow blocks instead of at the circuit level. This commit temporarily updates the references of these to the state of what is generated currently to unblock CI. If/when we have a fix this commit can be reverted. * Apply suggestions from code review Co-authored-by: Raynel Sanchez <87539502+raynelfss@users.noreply.github.com> * code review * Fix edge cases in DAGOpNode.__eq__ This commit fixes a couple of edge cases in DAGOpNode.__eq__ method around the python interaction for the method. The first is that in the case where we had python object parameter types for the gates we weren't comparing them at all. This is fixed so we use python object equality for the params in this case. Then we were dropping the error handling in the case of using python for equality, this fixes it to return the error to users if the equality check fails. Finally a comment is added to explain the expected use case for `DAGOpNode.__eq__` and why parameter checking is more strict than elsewhere. * Remove Param::add() for global phase addition This commit removes the Param::add() method and instead adds a local private function to the `dag_circuit` module for doing global phase addition. Previously the `Param::add()` method was used solely for adding global phase in `DAGCircuit` and it took some shortcuts knowing that context. This made the method implementation ill suited as a general implementation. * More complete fix for matplotlib drawer. * Revert "Update visual mpl circuit drawer references for control flow circuits" This reverts commit 9a6f9536a3a7412d19a9fd9bbd761825c9a53d0f. * Unify rayon versions in workspace * Remove unused _GLOBAL_NID. * Use global monotonic ID counter for ids in drawer The fundamental issue with matplotlib visualizations of control flow is that locally in the control flow block the nodes look the same but are stored in an outer circuit dictionary. If the gates are the same and on the same qubits and happen to have the same node id inside the different control flow blocks the drawer would think it's already drawn the node and skip it incorrectly. The previous fix for this didn't go far enough because it wasn't accounting for the recursive execution of the drawer for inner blocks (it also didn't account for LayerSpoolers of the same length). * Remove unused BitData iterator stuff. * Fully port Optimize1qGatesDecomposition to Rust This commit builds off of #12550 and the other data model in Rust infrastructure and migrates the Optimize1qGatesDecomposition pass to operate fully in Rust. The full path of the transpiler pass now never leaves rust until it has finished modifying the DAGCircuit. There is still some python interaction necessary to handle parts of the data model that are still in Python, mainly calibrations and parameter expressions (for global phase). But otherwise the entirety of the pass operates in rust now. This is just a first pass at the migration here, it moves the pass to be a single for loop in rust. The next steps here are to look at operating the pass in parallel. There is no data dependency between the optimizations being done by the pass so we should be able to the throughput of the pass by leveraging multithreading to handle each run in parallel. This commit does not attempt this though, because of the Python dependency and also the data structures around gates and the dag aren't really setup for multithreading yet and there likely will need to be some work to support that (this pass is a good candidate to work through the bugs on that). Part of #12208 * remove with_gil in favor of passing python tokens as params * Apply suggestions from code review Co-authored-by: Raynel Sanchez <87539502+raynelfss@users.noreply.github.com> * fmt * python serialization * deprecation * Update commutation_checker.py * heh * init * let Pytuple collect * lint * First set of comments - use Qubit/Clbit - more info on unsafe - update reno - use LazySet less - use OperationRef, avoid CircuitInstruction creation * Second part - clippy - no BigInt - more comments * Matrix speed & fix string sort -- could not use op.name() directly since sorted differently than Python, hence it's back to BigInt * have the Python implementation use Rust * lint & tools * remove unsafe blocks * One more try to avoid segfaulty windows -- if that doesn't work maybe revert the change the the Py CommChecker uses Rust * Original version Co-authored-by: Sebastian Brandhofer <148463728+sbrandhsn@users.noreply.github.com> * Sync with updated CommutationChecker todo: shouldn't make the qubits interner public * Debug: disable cache trying to figure out why the windows CI fails (after being unable to locally reproduce we're using CI with a reduced set of tests) * ... second try * Update crates/accelerate/src/commutation_checker.rs Co-authored-by: Raynel Sanchez <87539502+raynelfss@users.noreply.github.com> * Restore azure config * Remove unused import * Revert "Debug: disable cache" This reverts commit c564b806c9ff31d5faa6aa3f02c18cfe6a5ff2c5. * Don't overallocate cache We were allocating a the cache hashmap with a capacity for max cache size entries every time we instantiated a new CommutationChecker. The max cache size is 1 million. This meant we were allocating 162MB everytime CommutationChecker.__new__ was called, which includes each time we instantiate it manually (which happens once on import), the CommutationAnalysis pass gets instantiated (twice per preset pass manager created with level 2 or 3), or a commutation checker instance is pickle deserialized. This ends up causing a fairly large memory regression and is the source of the CI failures on windows. Co-authored-by: Jake Lishman * Cleanup parameter key type to handle edge conditions better This commit cleans up the ParameterKey type and usage to make it handle edge conditions better. The first is that the type just doesn't do the right thing for NaN, -0, or the infinities. Canonicalization is added for hash on -0 and the only constructor of the newtype adds a runtime guard against NaN and inifinity (positive or negative) to avoid that issue. The approach only makes sense as the cache is really there to guard us against unnecessary re-computing when we reiterate over the circuit > 1 time and nothing has changed for gates. Otherwise comparing floats like done in this PR does would not be a sound or an effective approach. * Remove unnecessary cache hit rate tracking * Undo test assertion changes * Undo unrelated test changes * Undo pending deprecation and unify commutation classes This commit removes the pending deprecation decorator from the python class definition as the Python class just internally is using the rust implementation now. This also removes directly using the rust implementation for the standard commutation library global as using the python class is exactly the same now. We can revisit if there is anything we want to deprecate and remove in 2.0 in a follow up PR. Personally, I think the cache management methods are all we really want to remove as the cache should be an internal implementation detail and not part of the public interface. * Undo gha config changes * Make serialization explicit This commit makes the pickling of cache entries explicit. Previously it was relying on conversion traits which hid some of the complexity but this uses a pair of conversion functions instead. * Remove stray SAFETY comment * Remove ddt usage from the tests Now that the python commutation checker and the rust commutation checker are the same thing the ddt parameterization of the commutation checker tests was unecessary duplication. This commit removes the ddt usage to restore having a single run of all the tests. * Update release note * Fix CommutationChecker class import * Remove invalid test assertion for no longer public attribute * Ray's review comments Co-authored-by: Raynel Sanchez * Handle ``atol/rtol``, more error propagation * update to latest changes in commchecker * fix merge conflict remnants * re-use expensive quantities such as the relative placement and the parameter hash * add missing header * gentler error handling * review comments & more docs * Use vec over IndexSet + clippy - vec is slightly faster than vec - add custom types to satisfies clippy's complex type complaint - don't handle Clbit/Var * Simplify python class construction Since this PR was first written the split between the python side and rust side of the CommutationChecker class has changed so that there are no longer separate classes anymore. The implementations are unified and the python space class just wraps an inner rust object. However, the construction of the CommutationAnalysis pass was still written assuming there was the possibility to get either a rust or Python object. This commit fixes this and the type change on the `comm_checker` attribute by removing the unnecessary logic. --------- Co-authored-by: Raynel Sanchez <87539502+raynelfss@users.noreply.github.com> Co-authored-by: Kevin Hartman Co-authored-by: Matthew Treinish Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> Co-authored-by: Alexander Ivrii Co-authored-by: Eli Arbel <46826214+eliarbel@users.noreply.github.com> Co-authored-by: John Lapeyre Co-authored-by: Jake Lishman Co-authored-by: Julien Gacon Co-authored-by: Raynel Sanchez --- crates/accelerate/src/commutation_analysis.rs | 192 ++++++++++++++++++ crates/accelerate/src/commutation_checker.rs | 4 +- crates/accelerate/src/lib.rs | 1 + crates/circuit/src/dag_circuit.rs | 2 +- crates/pyext/src/lib.rs | 19 +- qiskit/__init__.py | 1 + .../optimization/commutation_analysis.py | 52 +---- ...commutation-analysis-d2fc81feb6ca80aa.yaml | 4 + 8 files changed, 214 insertions(+), 61 deletions(-) create mode 100644 crates/accelerate/src/commutation_analysis.rs create mode 100644 releasenotes/notes/oxidize-commutation-analysis-d2fc81feb6ca80aa.yaml diff --git a/crates/accelerate/src/commutation_analysis.rs b/crates/accelerate/src/commutation_analysis.rs new file mode 100644 index 000000000000..08fa1dda5ec9 --- /dev/null +++ b/crates/accelerate/src/commutation_analysis.rs @@ -0,0 +1,192 @@ +// This code is part of Qiskit. +// +// (C) Copyright IBM 2024 +// +// This code is licensed under the Apache License, Version 2.0. You may +// obtain a copy of this license in the LICENSE.txt file in the root directory +// of this source tree or at http://www.apache.org/licenses/LICENSE-2.0. +// +// Any modifications or derivative works of this code must retain this +// copyright notice, and modified files need to carry a notice indicating +// that they have been altered from the originals. + +use pyo3::exceptions::PyValueError; +use pyo3::prelude::PyModule; +use pyo3::{pyfunction, pymodule, wrap_pyfunction, Bound, PyResult, Python}; +use qiskit_circuit::Qubit; + +use crate::commutation_checker::CommutationChecker; +use hashbrown::HashMap; +use pyo3::prelude::*; + +use pyo3::types::{PyDict, PyList}; +use qiskit_circuit::dag_circuit::{DAGCircuit, NodeType, Wire}; +use rustworkx_core::petgraph::stable_graph::NodeIndex; + +// Custom types to store the commutation sets and node indices, +// see the docstring below for more information. +type CommutationSet = HashMap>>; +type NodeIndices = HashMap<(NodeIndex, Wire), usize>; + +// the maximum number of qubits we check commutativity for +const MAX_NUM_QUBITS: u32 = 3; + +/// Compute the commutation sets for a given DAG. +/// +/// We return two HashMaps: +/// * {wire: commutation_sets}: For each wire, we keep a vector of index sets, where each index +/// set contains mutually commuting nodes. Note that these include the input and output nodes +/// which do not commute with anything. +/// * {(node, wire): index}: For each (node, wire) pair we store the index indicating in which +/// commutation set the node appears on a given wire. +/// +/// For example, if we have a circuit +/// +/// |0> -- X -- SX -- Z (out) +/// 0 2 3 4 1 <-- node indices including input (0) and output (1) nodes +/// +/// Then we would have +/// +/// commutation_set = {0: [[0], [2, 3], [4], [1]]} +/// node_indices = {(0, 0): 0, (1, 0): 3, (2, 0): 1, (3, 0): 1, (4, 0): 2} +/// +fn analyze_commutations_inner( + py: Python, + dag: &mut DAGCircuit, + commutation_checker: &mut CommutationChecker, +) -> PyResult<(CommutationSet, NodeIndices)> { + let mut commutation_set: CommutationSet = HashMap::new(); + let mut node_indices: NodeIndices = HashMap::new(); + + for qubit in 0..dag.num_qubits() { + let wire = Wire::Qubit(Qubit(qubit as u32)); + + for current_gate_idx in dag.nodes_on_wire(py, &wire, false) { + // get the commutation set associated with the current wire, or create a new + // index set containing the current gate + let commutation_entry = commutation_set + .entry(wire.clone()) + .or_insert_with(|| vec![vec![current_gate_idx]]); + + // we can unwrap as we know the commutation entry has at least one element + let last = commutation_entry.last_mut().unwrap(); + + // if the current gate index is not in the set, check whether it commutes with + // the previous nodes -- if yes, add it to the commutation set + if !last.contains(¤t_gate_idx) { + let mut all_commute = true; + + for prev_gate_idx in last.iter() { + // if the node is an input/output node, they do not commute, so we only + // continue if the nodes are operation nodes + if let (NodeType::Operation(packed_inst0), NodeType::Operation(packed_inst1)) = + (&dag.dag[current_gate_idx], &dag.dag[*prev_gate_idx]) + { + let op1 = packed_inst0.op.view(); + let op2 = packed_inst1.op.view(); + let params1 = packed_inst0.params_view(); + let params2 = packed_inst1.params_view(); + let qargs1 = dag.get_qargs(packed_inst0.qubits); + let qargs2 = dag.get_qargs(packed_inst1.qubits); + let cargs1 = dag.get_cargs(packed_inst0.clbits); + let cargs2 = dag.get_cargs(packed_inst1.clbits); + + all_commute = commutation_checker.commute_inner( + py, + &op1, + params1, + packed_inst0.extra_attrs.as_deref(), + qargs1, + cargs1, + &op2, + params2, + packed_inst1.extra_attrs.as_deref(), + qargs2, + cargs2, + MAX_NUM_QUBITS, + )?; + if !all_commute { + break; + } + } else { + all_commute = false; + break; + } + } + + if all_commute { + // all commute, add to current list + last.push(current_gate_idx); + } else { + // does not commute, create new list + commutation_entry.push(vec![current_gate_idx]); + } + } + + node_indices.insert( + (current_gate_idx, wire.clone()), + commutation_entry.len() - 1, + ); + } + } + + Ok((commutation_set, node_indices)) +} + +#[pyfunction] +#[pyo3(signature = (dag, commutation_checker))] +pub(crate) fn analyze_commutations( + py: Python, + dag: &mut DAGCircuit, + commutation_checker: &mut CommutationChecker, +) -> PyResult> { + // This returns two HashMaps: + // * The commuting nodes per wire: {wire: [commuting_nodes_1, commuting_nodes_2, ...]} + // * The index in which commutation set a given node is located on a wire: {(node, wire): index} + // The Python dict will store both of these dictionaries in one. + let (commutation_set, node_indices) = analyze_commutations_inner(py, dag, commutation_checker)?; + + let out_dict = PyDict::new_bound(py); + + // First set the {wire: [commuting_nodes_1, ...]} bit + for (wire, commutations) in commutation_set { + // we know all wires are of type Wire::Qubit, since in analyze_commutations_inner + // we only iterater over the qubits + let py_wire = match wire { + Wire::Qubit(q) => dag.qubits.get(q).unwrap().to_object(py), + _ => return Err(PyValueError::new_err("Unexpected wire type.")), + }; + + out_dict.set_item( + py_wire, + PyList::new_bound( + py, + commutations.iter().map(|inner| { + PyList::new_bound( + py, + inner + .iter() + .map(|node_index| dag.get_node(py, *node_index).unwrap()), + ) + }), + ), + )?; + } + + // Then we add the {(node, wire): index} dictionary + for ((node_index, wire), index) in node_indices { + let py_wire = match wire { + Wire::Qubit(q) => dag.qubits.get(q).unwrap().to_object(py), + _ => return Err(PyValueError::new_err("Unexpected wire type.")), + }; + out_dict.set_item((dag.get_node(py, node_index)?, py_wire), index)?; + } + + Ok(out_dict.unbind()) +} + +#[pymodule] +pub fn commutation_analysis(m: &Bound) -> PyResult<()> { + m.add_wrapped(wrap_pyfunction!(analyze_commutations))?; + Ok(()) +} diff --git a/crates/accelerate/src/commutation_checker.rs b/crates/accelerate/src/commutation_checker.rs index 6fd9d58a7c23..b00d7c624c92 100644 --- a/crates/accelerate/src/commutation_checker.rs +++ b/crates/accelerate/src/commutation_checker.rs @@ -69,7 +69,7 @@ where /// lookups. It's not meant to be a public facing Python object though and only used /// internally by the Python class. #[pyclass(module = "qiskit._accelerate.commutation_checker")] -struct CommutationChecker { +pub struct CommutationChecker { library: CommutationLibrary, cache_max_entries: usize, cache: HashMap<(String, String), CommutationCacheEntry>, @@ -227,7 +227,7 @@ impl CommutationChecker { impl CommutationChecker { #[allow(clippy::too_many_arguments)] - fn commute_inner( + pub fn commute_inner( &mut self, py: Python, op1: &OperationRef, diff --git a/crates/accelerate/src/lib.rs b/crates/accelerate/src/lib.rs index 3a8c4bf51071..6561dd258614 100644 --- a/crates/accelerate/src/lib.rs +++ b/crates/accelerate/src/lib.rs @@ -15,6 +15,7 @@ use std::env; use pyo3::import_exception; pub mod circuit_library; +pub mod commutation_analysis; pub mod commutation_checker; pub mod convert_2q_block_matrix; pub mod dense_layout; diff --git a/crates/circuit/src/dag_circuit.rs b/crates/circuit/src/dag_circuit.rs index 90a4c75408fa..fdaa81e3b4ca 100644 --- a/crates/circuit/src/dag_circuit.rs +++ b/crates/circuit/src/dag_circuit.rs @@ -5530,7 +5530,7 @@ impl DAGCircuit { /// Get the nodes on the given wire. /// /// Note: result is empty if the wire is not in the DAG. - fn nodes_on_wire(&self, py: Python, wire: &Wire, only_ops: bool) -> Vec { + pub fn nodes_on_wire(&self, py: Python, wire: &Wire, only_ops: bool) -> Vec { let mut nodes = Vec::new(); let mut current_node = match wire { Wire::Qubit(qubit) => self.qubit_io_map.get(qubit.0 as usize).map(|x| x[0]), diff --git a/crates/pyext/src/lib.rs b/crates/pyext/src/lib.rs index 24a4badf6539..fdb2bff9a21d 100644 --- a/crates/pyext/src/lib.rs +++ b/crates/pyext/src/lib.rs @@ -13,15 +13,15 @@ use pyo3::prelude::*; use qiskit_accelerate::{ - circuit_library::circuit_library, commutation_checker::commutation_checker, - convert_2q_block_matrix::convert_2q_block_matrix, dense_layout::dense_layout, - error_map::error_map, euler_one_qubit_decomposer::euler_one_qubit_decomposer, - isometry::isometry, nlayout::nlayout, optimize_1q_gates::optimize_1q_gates, - pauli_exp_val::pauli_expval, results::results, sabre::sabre, sampled_exp_val::sampled_exp_val, - sparse_pauli_op::sparse_pauli_op, star_prerouting::star_prerouting, - stochastic_swap::stochastic_swap, synthesis::synthesis, target_transpiler::target, - two_qubit_decompose::two_qubit_decompose, uc_gate::uc_gate, utils::utils, - vf2_layout::vf2_layout, + circuit_library::circuit_library, commutation_analysis::commutation_analysis, + commutation_checker::commutation_checker, convert_2q_block_matrix::convert_2q_block_matrix, + dense_layout::dense_layout, error_map::error_map, + euler_one_qubit_decomposer::euler_one_qubit_decomposer, isometry::isometry, nlayout::nlayout, + optimize_1q_gates::optimize_1q_gates, pauli_exp_val::pauli_expval, results::results, + sabre::sabre, sampled_exp_val::sampled_exp_val, sparse_pauli_op::sparse_pauli_op, + star_prerouting::star_prerouting, stochastic_swap::stochastic_swap, synthesis::synthesis, + target_transpiler::target, two_qubit_decompose::two_qubit_decompose, uc_gate::uc_gate, + utils::utils, vf2_layout::vf2_layout, }; #[inline(always)] @@ -62,5 +62,6 @@ fn _accelerate(m: &Bound) -> PyResult<()> { add_submodule(m, utils, "utils")?; add_submodule(m, vf2_layout, "vf2_layout")?; add_submodule(m, commutation_checker, "commutation_checker")?; + add_submodule(m, commutation_analysis, "commutation_analysis")?; Ok(()) } diff --git a/qiskit/__init__.py b/qiskit/__init__.py index 67384b38971a..38a9f5952425 100644 --- a/qiskit/__init__.py +++ b/qiskit/__init__.py @@ -87,6 +87,7 @@ sys.modules["qiskit._accelerate.synthesis.linear"] = _accelerate.synthesis.linear sys.modules["qiskit._accelerate.synthesis.clifford"] = _accelerate.synthesis.clifford sys.modules["qiskit._accelerate.commutation_checker"] = _accelerate.commutation_checker +sys.modules["qiskit._accelerate.commutation_analysis"] = _accelerate.commutation_analysis sys.modules["qiskit._accelerate.synthesis.linear_phase"] = _accelerate.synthesis.linear_phase from qiskit.exceptions import QiskitError, MissingOptionalLibraryError diff --git a/qiskit/transpiler/passes/optimization/commutation_analysis.py b/qiskit/transpiler/passes/optimization/commutation_analysis.py index 12ed7145eec7..d801e4775937 100644 --- a/qiskit/transpiler/passes/optimization/commutation_analysis.py +++ b/qiskit/transpiler/passes/optimization/commutation_analysis.py @@ -12,11 +12,9 @@ """Analysis pass to find commutation relations between DAG nodes.""" -from collections import defaultdict - from qiskit.circuit.commutation_library import SessionCommutationChecker as scc -from qiskit.dagcircuit import DAGOpNode from qiskit.transpiler.basepasses import AnalysisPass +from qiskit._accelerate.commutation_analysis import analyze_commutations class CommutationAnalysis(AnalysisPass): @@ -33,6 +31,7 @@ def __init__(self, *, _commutation_checker=None): # do not care about commutations of all gates, but just a subset if _commutation_checker is None: _commutation_checker = scc + self.comm_checker = _commutation_checker def run(self, dag): @@ -42,49 +41,4 @@ def run(self, dag): into the ``property_set``. """ # Initiate the commutation set - self.property_set["commutation_set"] = defaultdict(list) - - # Build a dictionary to keep track of the gates on each qubit - # The key with format (wire) will store the lists of commutation sets - # The key with format (node, wire) will store the index of the commutation set - # on the specified wire, thus, for example: - # self.property_set['commutation_set'][wire][(node, wire)] will give the - # commutation set that contains node. - - for wire in dag.qubits: - self.property_set["commutation_set"][wire] = [] - - # Add edges to the dictionary for each qubit - for node in dag.topological_op_nodes(): - for _, _, edge_wire in dag.edges(node): - self.property_set["commutation_set"][(node, edge_wire)] = -1 - - # Construct the commutation set - for wire in dag.qubits: - - for current_gate in dag.nodes_on_wire(wire): - - current_comm_set = self.property_set["commutation_set"][wire] - if not current_comm_set: - current_comm_set.append([current_gate]) - - if current_gate not in current_comm_set[-1]: - does_commute = True - - # Check if the current gate commutes with all the gates in the current block - for prev_gate in current_comm_set[-1]: - does_commute = ( - isinstance(current_gate, DAGOpNode) - and isinstance(prev_gate, DAGOpNode) - and self.comm_checker.commute_nodes(current_gate, prev_gate) - ) - if not does_commute: - break - - if does_commute: - current_comm_set[-1].append(current_gate) - else: - current_comm_set.append([current_gate]) - - temp_len = len(current_comm_set) - self.property_set["commutation_set"][(current_gate, wire)] = temp_len - 1 + self.property_set["commutation_set"] = analyze_commutations(dag, self.comm_checker.cc) diff --git a/releasenotes/notes/oxidize-commutation-analysis-d2fc81feb6ca80aa.yaml b/releasenotes/notes/oxidize-commutation-analysis-d2fc81feb6ca80aa.yaml new file mode 100644 index 000000000000..967a65bcebab --- /dev/null +++ b/releasenotes/notes/oxidize-commutation-analysis-d2fc81feb6ca80aa.yaml @@ -0,0 +1,4 @@ +--- +features_transpiler: + - | + Added a Rust implementation of :class:`.CommutationAnalysis` in :func:`.analyze_commutations`.