8000 Add unitary gate representation to rust by mtreinish · Pull Request #13759 · Qiskit/qiskit · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add unitary gate representation to rust #13759

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Feb 5, 2025
Merged

Add unitary gate representation to rust #13759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5b3b80b
Add unitary gate representation to rust
mtreinish Jan 29, 2025
78610ef
Fix basic simulator and document difference in params
mtreinish Feb 5, 2025
66d397d
Update UnitaryGate docstring
mtreinish Feb 5, 2025
e1d6b9b
Unify matching arms for unitary gate in DAGCircuit::__eq__
mtreinish Feb 5, 2025
ffb2ecf
Immediately box UnitaryGate from python
mtreinish Feb 5, 2025
275b01d
Merge branch 'main' into unitary-gate-rs
mtreinish Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ indexmap.version = "2.7.1"
hashbrown.version = "0.14.5"
num-bigint = "0.4"
num-complex = "0.4"
nalgebra = "0.33"
ndarray = "0.15"
numpy = "0.23"
smallvec = "1.13"
Expand Down
3 changes: 3 additions & 0 deletions crates/accelerate/src/target_transpiler/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -783,6 +783,9 @@ impl Target {
OperationRef::Gate(gate) => gate.gate.clone_ref(py),
OperationRef::Instruction(instruction) => instruction.instruction.clone_ref(py),
OperationRef::Operation(operation) => operation.operation.clone_ref(py),
OperationRef::Unitary(unitary) => unitary
.create_py_op(py, &ExtraInstructionAttributes::default())?
.into_any(),
},
TargetOperation::Variadic(op_cls) => op_cls.clone_ref(py),
};
Expand Down
6 changes: 5 additions & 1 deletion crates/circuit/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ bytemuck.workspace = true
bitfield-struct.workspace = true
num-complex.workspace = true
ndarray.workspace = true
numpy.workspace = true
thiserror.workspace = true
approx.workspace = true
itertools.workspace = true
nalgebra.workspace = true

[dependencies.pyo3]
workspace = true
Expand All @@ -41,6 +41,10 @@ features = ["rayon"]
workspace = true
features = ["union", "const_generics"]

[dependencies.numpy]
workspace = true
features = ["nalgebra"]

[features]
cache_pygates = []

Expand Down
49 changes: 46 additions & 3 deletions crates/circuit/src/circuit_instruction.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,24 @@
#[cfg(feature = "cache_pygates")]
use std::sync::OnceLock;

use numpy::{IntoPyArray, PyArray2};
use numpy::{IntoPyArray, PyArray2, PyReadonlyArray2};
use pyo3::basic::CompareOp;
use pyo3::exceptions::{PyDeprecationWarning, PyTypeError};
use pyo3::prelude::*;
use pyo3::types::{PyBool, PyList, PyString, PyTuple, PyType};
use pyo3::IntoPyObjectExt;
use pyo3::{intern, PyObject, PyResult};

use nalgebra::{MatrixView2, MatrixView4};
use num_complex::Complex64;
use smallvec::SmallVec;

use crate::imports::{
CONTROLLED_GATE, CONTROL_FLOW_OP, GATE, INSTRUCTION, OPERATION, WARNINGS_WARN,
};
use crate::operations::{
Operation, OperationRef, Param, PyGate, PyInstruction, PyOperation, StandardGate,
StandardInstruction, StandardInstructionType,
ArrayType, Operation, OperationRef, Param, PyGate, PyInstruction, PyOperation, StandardGate,
StandardInstruction, StandardInstructionType, UnitaryGate,
};
use crate::packed_instruction::PackedOperation;

Expand Down Expand Up @@ -341,6 +342,9 @@ impl CircuitInstruction {
OperationRef::Gate(gate) => gate.gate.clone_ref(py),
OperationRef::Instruction(instruction) => instruction.instruction.clone_ref(py),
OperationRef::Operation(operation) => operation.operation.clone_ref(py),
OperationRef::Unitary(unitary) => {
unitary.create_py_op(py, &self.extra_attrs)?.into_any()
}
};

#[cfg(feature = "cache_pygates")]
Expand Down Expand Up @@ -762,6 +766,45 @@ impl<'py> FromPyObject<'py> for OperationFromPython {
});
}

// We need to check by name here to avoid a circular import during initial loading
if ob.getattr(intern!(py, "name"))?.extract::<String>()? == "unitary" {
let params = extract_params()?;
if let Param::Obj(data) = &params[0] {
let py_matrix: PyReadonlyArray2<Complex64> = data.extract(py)?;
let matrix: Option<MatrixView2<Complex64>> = py_matrix.try_as_matrix();
if let Some(x) = matrix {
let unitary_gate = Box::new(UnitaryGate {
array: ArrayType::OneQ(x.into_owned()),
});
return Ok(OperationFromPython {
operation: PackedOperation::from_unitary(unitary_gate),
params: SmallVec::new(),
extra_attrs: extract_extra()?,
});
}
let matrix: Option<MatrixView4<Complex64>> = py_matrix.try_as_matrix();
if let Some(x) = matrix {
let unitary_gate = Box::new(UnitaryGate {
array: ArrayType::TwoQ(x.into_owned()),
});
return Ok(OperationFromPython {
operation: PackedOperation::from_unitary(unitary_gate),
params: SmallVec::new(),
extra_attrs: extract_extra()?,
});
} else {
let unitary_gate = Box::new(UnitaryGate {
array: ArrayType::NDArray(py_matrix.as_array().to_owned()),
});
return Ok(OperationFromPython {
operation: PackedOperation::from_unitary(unitary_gate),
params: SmallVec::new(),
extra_attrs: extract_extra()?,
});
};
}
}

if ob_type.is_subclass(GATE.get_bound(py))? {
let params = extract_params()?;
let gate = Box::new(PyGate {
Expand Down
66 changes: 61 additions & 5 deletions crates/circuit/src/dag_circuit.rs
View file
Open in desktop
10A5E
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use std::hash::Hash;

use ahash::RandomState;
use approx::relative_eq;
use smallvec::SmallVec;

use crate::bit_data::BitData;
Expand All @@ -26,7 +27,7 @@ use crate::dot_utils::build_dot;
use crate::error::DAGCircuitError;
use crate::imports;
use crate::interner::{Interned, InternedMap, Interner};
use crate::operations::{Operation, OperationRef, Param, PyInstruction, StandardGate};
use crate::operations::{ArrayType, Operation, OperationRef, Param, PyInstruction, StandardGate};
use crate::packed_instruction::{PackedInstruction, PackedOperation};
use crate::rustworkx_core_vnext::isomorphism;
use crate::{BitType, Clbit, Qubit, TupleLikeArg};
Expand Down Expand Up @@ -2631,6 +2632,60 @@ def _format(operand):
| [OperationRef::Instruction(_), OperationRef::StandardInstruction(_)] => {
Ok(inst1.py_op_eq(py, inst2)? && check_args() && check_conditions()?)
}
[OperationRef::Unitary(op_a), OperationRef::Unitary(op_b)] => {
match [&op_a.array, &op_b.array] {
[ArrayType::NDArray(a), ArrayType::NDArray(b)] => {
Ok(relative_eq!(a, b, max_relative = 1e-5, epsilon = 1e-8))
Copy link
Contributor

Choose a reason for hiding this comment

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

Less of a comment on this PR and more of a general question, but what is max_relative vs epsilon, exactly?

I spent some time looking at the docs for the approx crate, but I could quite grok it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Hah, what docs? It's very sparse from what I remember.

The relative_eq! macro is basically checking something like: abs(a - b) <= epsilon + max_relative * abs(b). The equivalent in python land would be numpy.is_close() where epsilon is the atol argument and max_relative is rtol. You can look at the impl for the RelativeEq trait for f64 to get a feeling for how it works.

}
[ArrayType::OneQ(a), ArrayType::NDArray(b)]
| [ArrayType::NDArray(b), ArrayType::OneQ(a)] => {
if b.shape()[0] == 2 {
for i in 0..2 {
for j in 0..2 {
if !relative_eq!(
b[[i, j]],
a[(i, j)],
max_relative = 1e-5,
epsilon = 1e-8
) {
return Ok(false);
}
}
}
Ok(true)
} else {
Ok(false)
}
}
[ArrayType::TwoQ(a), ArrayType::NDArray(b)]
| [ArrayType::NDArray(b), ArrayType::TwoQ(a)] => {
if b.shape()[0] == 4 {
for i in 0..4 {
for j in 0..4 {
if !relative_eq!(
b[[i, j]],
a[(i, j)],
max_relative = 1e-5,
epsilon = 1e-8
) {
return Ok(false);
}
}
}
Ok(true)
} else {
Ok(false)
}
}
[ArrayType::OneQ(a), ArrayType::OneQ(b)] => {
Ok(relative_eq!(a, b, max_relative = 1e-5, epsilon = 1e-8))
}
[ArrayType::TwoQ(a), ArrayType::TwoQ(b)] => {
Ok(relative_eq!(a, b, max_relative = 1e-5, epsilon = 1e-8))
}
_ => Ok(false),
}
}
_ => Ok(false),
}
}
Expand Down Expand Up @@ -3295,7 +3350,8 @@ def _format(operand):
py_op.operation.setattr(py, "condition", new_condition)?;
}
OperationRef::StandardGate(_)
| OperationRef::StandardInstruction(_) => {}
| OperationRef::StandardInstruction(_)
| OperationRef::Unitary(_) => {}
}
}
}
Expand Down Expand Up @@ -6315,9 +6371,9 @@ impl DAGCircuit {
};
#[cfg(feature = "cache_pygates")]
let py_op = match new_op.operation.view() {
OperationRef::StandardGate(_) | OperationRef::StandardInstruction(_) => {
OnceLock::new()
}
OperationRef::StandardGate(_)
| OperationRef::StandardInstruction(_)
| OperationRef::Unitary(_) => OnceLock::new(),
OperationRef::Gate(gate) => OnceLock::from(gate.gate.clone_ref(py)),
OperationRef::Instruction(instruction) => {
OnceLock::from(instruction.instruction.clone_ref(py))
Expand Down
Loading
0