-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fully port InverseCancellation to Rust
This commit builds off of #12959 and the other data model in Rust infrastructure and migrates the InverseCancellation 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 for handling parameter expressions. 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 use loops 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 for different inverse gates/pairs so we should be able to the throughput of the pass by leveraging multithreading to handle each inverse option 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. Fixes #12271 Part of #12208
- Loading branch information
Showing
6 changed files
with
261 additions
and
139 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| // 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 ahash::RandomState; | ||
| use hashbrown::HashSet; | ||
| use indexmap::IndexMap; | ||
| use pyo3::prelude::*; | ||
| use rustworkx_core::petgraph::stable_graph::NodeIndex; | ||
|
|
||
| use qiskit_circuit::circuit_instruction::OperationFromPython; | ||
| use qiskit_circuit::dag_circuit::{DAGCircuit, NodeType}; | ||
| use qiskit_circuit::operations::Operation; | ||
| use qiskit_circuit::packed_instruction::PackedInstruction; | ||
|
|
||
| fn gate_eq(py: Python, gate_a: &PackedInstruction, gate_b: &OperationFromPython) -> PyResult<bool> { | ||
| if gate_a.op.name() != gate_b.operation.name() { | ||
| return Ok(false); | ||
| } | ||
| let a_params = gate_a.params_view(); | ||
| if a_params.len() != gate_b.params.len() { | ||
| return Ok(false); | ||
| } | ||
| let mut param_eq = true; | ||
| for (a, b) in a_params.iter().zip(&gate_b.params) { | ||
| if !a.is_close(py, b, 1e-10)? { | ||
| param_eq = false; | ||
| break; | ||
| } | ||
| } | ||
| Ok(param_eq) | ||
| } | ||
|
|
||
| fn run_on_self_inverse( | ||
| py: Python, | ||
| dag: &mut DAGCircuit, | ||
| op_counts: &IndexMap<String, usize, RandomState>, | ||
| self_inverse_gate_names: HashSet<String>, | ||
| self_inverse_gates: Vec<OperationFromPython>, | ||
| ) -> PyResult<()> { | ||
| if !self_inverse_gate_names | ||
| .iter() | ||
| .any(|name| op_counts.contains_key(name)) | ||
| { | ||
| return Ok(()); | ||
| } | ||
| for gate in self_inverse_gates { | ||
| let gate_count = op_counts.get(gate.operation.name()).unwrap_or(&0); | ||
| if *gate_count <= 1 { | ||
| continue; | ||
| } | ||
| let mut collect_set: HashSet<String> = HashSet::with_capacity(1); | ||
| collect_set.insert(gate.operation.name().to_string()); | ||
| let gate_runs: Vec<Vec<NodeIndex>> = dag.collect_runs(collect_set).unwrap().collect(); | ||
| for gate_cancel_run in gate_runs { | ||
| let mut partitions: Vec<Vec<NodeIndex>> = Vec::new(); | ||
| let mut chunk: Vec<NodeIndex> = Vec::new(); | ||
| let max_index = gate_cancel_run.len() - 1; | ||
| for (i, cancel_gate) in gate_cancel_run.iter().enumerate() { | ||
| let node = &dag.dag[*cancel_gate]; | ||
| if let NodeType::Operation(inst) = node { | ||
| if gate_eq(py, inst, &gate)? { | ||
| chunk.push(*cancel_gate); | ||
| } else { | ||
| let is_empty: bool = chunk.is_empty(); | ||
| if !is_empty { | ||
| partitions.push(std::mem::take(&mut chunk)); | ||
| } | ||
| continue; | ||
| } | ||
| if i == max_index { | ||
| partitions.push(std::mem::take(&mut chunk)); | ||
| } else { | ||
| let next_qargs = if let NodeType::Operation(next_inst) = | ||
| &dag.dag[gate_cancel_run[i + 1]] | ||
| { | ||
| next_inst.qubits | ||
| } else { | ||
| panic!("Not an op node") | ||
| }; | ||
| if inst.qubits != next_qargs { | ||
| partitions.push(std::mem::take(&mut chunk)); | ||
| } | ||
| } | ||
| } else { | ||
| panic!("Not an op node"); | ||
| } | ||
| } | ||
| for chunk in partitions { | ||
| if chunk.len() % 2 == 0 { | ||
| dag.remove_op_node(chunk[0]); | ||
| } | ||
| for node in &chunk[1..] { | ||
| dag.remove_op_node(*node); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| Ok(()) | ||
| } | ||
| fn run_on_inverse_pairs( | ||
| py: Python, | ||
| dag: &mut DAGCircuit, | ||
| op_counts: &IndexMap<String, usize, RandomState>, | ||
| inverse_gate_names: HashSet<String>, | ||
| inverse_gates: Vec<[OperationFromPython; 2]>, | ||
| ) -> PyResult<()> { | ||
| if !inverse_gate_names | ||
| .iter() | ||
| .any(|name| op_counts.contains_key(name)) | ||
| { | ||
| return Ok(()); | ||
| } | ||
| for pair in inverse_gates { | ||
| let gate_0_name = pair[0].operation.name(); | ||
| let gate_1_name = pair[1].operation.name(); | ||
| if !op_counts.contains_key(gate_0_name) || !op_counts.contains_key(gate_1_name) { | ||
| continue; | ||
| } | ||
| let names: HashSet<String> = pair | ||
| .iter() | ||
| .map(|x| x.operation.name().to_string()) | ||
| .collect(); | ||
| let runs: Vec<Vec<NodeIndex>> = dag.collect_runs(names).unwrap().collect(); | ||
| for nodes in runs { | ||
| let mut i = 0; | ||
| while i < nodes.len() - 1 { | ||
| if let NodeType::Operation(inst) = &dag.dag[nodes[i]] { | ||
| if let NodeType::Operation(next_inst) = &dag.dag[nodes[i + 1]] { | ||
| if inst.qubits == next_inst.qubits | ||
| && ((gate_eq(py, inst, &pair[0])? && gate_eq(py, next_inst, &pair[1])?) | ||
| || (gate_eq(py, inst, &pair[1])? | ||
| && gate_eq(py, next_inst, &pair[0])?)) | ||
| { | ||
| dag.remove_op_node(nodes[i]); | ||
| dag.remove_op_node(nodes[i + 1]); | ||
| i += 2; | ||
| } else { | ||
| i += 1; | ||
| } | ||
| } else { | ||
| panic!("Not an op node") | ||
| } | ||
| } else { | ||
| panic!("Not an op node") | ||
| } | ||
| } | ||
| } | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| #[pyfunction] | ||
| pub fn inverse_cancellation( | ||
| py: Python, | ||
| dag: &mut DAGCircuit, | ||
| inverse_gates: Vec<[OperationFromPython; 2]>, | ||
| self_inverse_gates: Vec<OperationFromPython>, | ||
| inverse_gate_names: HashSet<String>, | ||
| self_inverse_gate_names: HashSet<String>, | ||
| ) -> PyResult<()> { | ||
| let op_counts = if !self_inverse_gate_names.is_empty() || !inverse_gate_names.is_empty() { | ||
| dag.count_ops(py, true)? | ||
| } else { | ||
| IndexMap::default() | ||
| }; | ||
| if !self_inverse_gate_names.is_empty() { | ||
| run_on_self_inverse( | ||
| py, | ||
| dag, | ||
| &op_counts, | ||
| self_inverse_gate_names, | ||
| self_inverse_gates, | ||
| )?; | ||
| } | ||
| if !inverse_gate_names.is_empty() { | ||
| run_on_inverse_pairs(py, dag, &op_counts, inverse_gate_names, inverse_gates)?; | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| pub fn inverse_cancellation_mod(m: &Bound<PyModule>) -> PyResult<()> { | ||
| m.add_wrapped(wrap_pyfunction!(inverse_cancellation))?; | ||
| Ok(()) | ||
| } |
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 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 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 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
Oops, something went wrong.