Port linear_depth_lnn to rust #13654

gadial · 2025-01-13T09:23:49Z

Summary

Ports the optimize_cx_circ_depth_5n_line method to Rust.

Details and comments

This is synthesis pass for constructing general linear reversible circuits given by an invertible boolean matrix. The code generating the instruction list was ported to Rust in a straightforward manner; construction of the circuit itself is done in Python.

A quick benchmarking was performed by using random_invertible_binary_matrix(n, seed=seed) and timing the application of synth_cnot_depth_line_kms on the result, showing consistent improvement for the rust version.

╒═════════════════════╤═════════════╤═════════════╤═══════════════════════╕
│ Test Case           │        rust │      python │   Ratio (python/rust) │
╞═════════════════════╪═════════════╪═════════════╪═══════════════════════╡
│ 10x10 (seed 42)     │ 8.58307e-05 │ 0.00221419  │              25.7972  │
├─────────────────────┼─────────────┼─────────────┼───────────────────────┤
│ 5x5 (seed 42)       │ 9.48906e-05 │ 0.000352144 │               3.71106 │
├─────────────────────┼─────────────┼─────────────┼───────────────────────┤
│ 20x20 (seed 55)     │ 0.000299549 │ 0.00747766  │              24.9631  │
├─────────────────────┼─────────────┼─────────────┼───────────────────────┤
│ 50x50 (seed 13)     │ 0.00281119  │ 0.0665068   │              23.6579  │
├─────────────────────┼─────────────┼─────────────┼───────────────────────┤
│ 60x60 (seed 55)     │ 0.00581484  │ 0.119858    │              20.6124  │
├─────────────────────┼─────────────┼─────────────┼───────────────────────┤
│ 70x70 (seed 13)     │ 0.00826478  │ 0.168697    │              20.4115  │
├─────────────────────┼─────────────┼─────────────┼───────────────────────┤
│ 100x100 (seed 1089) │ 0.0262463   │ 0.439383    │              16.7407  │
├─────────────────────┼─────────────┼─────────────┼───────────────────────┤
│ 120x120 (seed 17)   │ 0.0428403   │ 0.675542    │              15.7688  │
├─────────────────────┼─────────────┼─────────────┼───────────────────────┤
│ 150x150 (seed 99)   │ 0.0835741   │ 1.47674     │              17.6699  │
╘═════════════════════╧═════════════╧═════════════╧═══════════════════════╛

qiskit-bot · 2025-01-13T09:23:54Z

One or more of the following people are relevant to this code:

@Qiskit/terra-core

coveralls · 2025-01-13T09:51:58Z

Pull Request Test Coverage Report for Build 12986663347

Details

244 of 250 (97.6%) changed or added relevant lines in 5 files are covered.
31 unchanged lines in 5 files lost coverage.
Overall coverage decreased (-0.01%) to 88.93%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
crates/accelerate/src/synthesis/linear/lnn.rs	226	227	99.56%
crates/accelerate/src/synthesis/linear/utils.rs	10	15	66.67%

Files with Coverage Reduction	New Missed Lines	%
crates/accelerate/src/unitary_synthesis.rs	1	92.97%
crates/qasm2/src/expr.rs	1	94.23%
crates/qasm2/src/lex.rs	7	91.98%
crates/accelerate/src/synthesis/linear/mod.rs	10	82.8%
crates/qasm2/src/parse.rs	12	97.15%

Totals
Change from base Build 12951053301:	-0.01%
Covered Lines:	79549
Relevant Lines:	89451

💛 - Coveralls

ShellyGarion

Thanks @gadial for your contribution! I only have some minor comments and questions.

crates/accelerate/src/synthesis/linear/lnn.rs

ShellyGarion · 2025-01-14T15:14:22Z

I also think we can add some release notes saying that there was a performance improvement in synth_cnot_depth_line_kms since it's implementation was ported to rust

alexanderivrii

Thanks Gadi, the PR looks very nice and is quite close to the original Python code. I have left a few comments in-place. The main one is probably to rethink which functions we want to expose from the rust side. You probably want to add release notes as well.

crates/accelerate/src/synthesis/linear/lnn.rs

alexanderivrii · 2025-01-15T11:30:15Z

crates/accelerate/src/synthesis/linear/lnn.rs

+#[pyfunction]
+#[pyo3(signature = (mat))]
+pub fn optimize_cx_circ_depth_5n_line(
+    _py: Python,
+    mat: PyReadonlyArray2<bool>,
+) -> PyResult<(InstructionList, InstructionList)> {


For the rust function to be entirely self-contained and for consistency with other synthesis functions, it would be nice to return PyResult<CircuitData>.

Done in 4902815

qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py

qiskit/synthesis/linear/linear_depth_lnn.py

qiskit/synthesis/linear_phase/cx_cz_depth_lnn.py

alexanderivrii

This looks great! I have left a few minor in-place suggestions, but I don't feel strongly about any of these, so feel free to ignore, I am completely happy to approve this PR just as it is right now. @ShellyGarion, please take a look to see if you have any more comments. I am not sure if we need release notes: on the one hand, we can skip release notes if there is no API change, but on the other hand it might be nice to highlight that a certain algorithm was ported to Rust, giving 20x performance speedup.

crates/accelerate/src/synthesis/linear/lnn.rs

alexanderivrii · 2025-01-23T08:39:01Z

crates/accelerate/src/synthesis/linear/lnn.rs

+        // Find the last "1" in row i, use COL operations to the left in order to
+        // zero out all other "1"s in that row.
+        let cols_to_update: Vec<usize> = (0..n).rev().filter(|&j| mat[[i, j]]).collect();
+        let (first_j, cols_to_update) = cols_to_update.split_first().unwrap();


oh nice! I didn't know about split_first before :)

alexanderivrii · 2025-01-23T08:41:54Z

crates/accelerate/src/synthesis/linear/lnn.rs

+        let cols_to_update: Vec<usize> = (0..n).rev().filter(|&j| mat[[i, j]]).collect();
+        let (first_j, cols_to_update) = cols_to_update.split_first().unwrap();
+        cols_to_update.iter().for_each(|j| {
+            _col_op_inv(mat.view_mut(), *j, *first_j);


Would it make sense to replace _col_op_inv by _col_op and swap the order of the arguments? (I know this is how it was done in the Python code, and badly named at that).

crates/accelerate/src/synthesis/linear/lnn.rs

alexanderivrii · 2025-01-23T08:58:15Z

crates/accelerate/src/synthesis/linear/lnn.rs

+#[pyfunction]
+#[pyo3(signature = (mat))]
+pub fn optimize_cx_circ_depth_5n_line(
+    _py: Python,


We can probably skip passing _py to the function.

The function name is not particularly representative of what the function is doing (in particular, it does not optimize anything). Maybe something like synth_cnot_depth_line_pair (but please find a better name than that). Also it seems that our new agreed on convention is to prefix python interface functions with py, i.e. let's change the names to py_synth_cnot_depth_line_pair and to py_synth_cnot_depth_line_kms. We don't follow this convention anywhere else in the synthesis code yet, but I believe someone is working on that already.

ShellyGarion

Generally it looks good. I only have a minor comment on the docs.

ShellyGarion · 2025-01-26T15:40:08Z

crates/accelerate/src/synthesis/linear/lnn.rs

+/// `arXiv:quant-ph/0701194 <https://arxiv.org/abs/quant-ph/0701194>`_.
+#[pyfunction]
+#[pyo3(signature = (mat))]
+pub fn py_synth_cnot_depth_line_kms(


this is a minor comment: both these pyfunctions have exactly the same docstring. could you add an explanation? it seems that the difference is in the args+returns. Could you please add them too (at least to the pyfunctions)?

ShellyGarion

LGTM, thanks @gadial !

Port linear_depth_lnn to rust

708c8fd

gadial requested review from alexanderivrii, ShellyGarion and a team as code owners January 13, 2025 09:23

gadial added 2 commits January 13, 2025 13:32

Merge branch 'main' into rust_linear_depth_lnn

a5e84c5

Remove unnecessary release note

3f74911

ShellyGarion added synthesis Rust This PR or issue is related to Rust code in the repository labels Jan 13, 2025

ShellyGarion reviewed Jan 14, 2025

View reviewed changes

ShellyGarion added the performance label Jan 14, 2025

alexanderivrii reviewed Jan 15, 2025

View reviewed changes

gadial added 2 commits January 20, 2025 12:43

Changes according to code review

4902815

More corrections based on the review

d29d7ee

gadial requested review from ShellyGarion and alexanderivrii January 20, 2025 14:16

alexanderivrii reviewed Jan 23, 2025

View reviewed changes

gadial added 2 commits January 23, 2025 13:54

Changes according to code review

e3c69e2

Small fix

c40c0e4

ShellyGarion reviewed Jan 26, 2025

View reviewed changes

gadial added 3 commits January 27, 2025 10:46

Docstring change according to PR review

5d5ed8f

Cargo fmt for version 1.79

3220dcd

Merge branch 'main' into rust_linear_depth_lnn

ff51b32

ShellyGarion approved these changes Jan 27, 2025

View reviewed changes

ShellyGarion added this pull request to the merge queue Jan 27, 2025

Merged via the queue into Qiskit:main with commit e4743a0 Jan 27, 2025
17 checks passed

gadial deleted the rust_linear_depth_lnn branch January 27, 2025 12:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Port linear_depth_lnn to rust #13654

Port linear_depth_lnn to rust #13654

gadial commented Jan 13, 2025 •

edited

Loading

qiskit-bot commented Jan 13, 2025

coveralls commented Jan 13, 2025 •

edited

Loading

ShellyGarion left a comment

ShellyGarion commented Jan 14, 2025

alexanderivrii left a comment

alexanderivrii Jan 15, 2025

gadial Jan 20, 2025

alexanderivrii left a comment

alexanderivrii Jan 23, 2025

alexanderivrii Jan 23, 2025

alexanderivrii Jan 23, 2025

alexanderivrii Jan 23, 2025

ShellyGarion left a comment

ShellyGarion Jan 26, 2025 •

edited

Loading

ShellyGarion left a comment

Port linear_depth_lnn to rust #13654

Port linear_depth_lnn to rust #13654

Conversation

gadial commented Jan 13, 2025 • edited Loading

Summary

Details and comments

qiskit-bot commented Jan 13, 2025

coveralls commented Jan 13, 2025 • edited Loading

Pull Request Test Coverage Report for Build 12986663347

Details

💛 - Coveralls

ShellyGarion left a comment

Choose a reason for hiding this comment

ShellyGarion commented Jan 14, 2025

alexanderivrii left a comment

Choose a reason for hiding this comment

alexanderivrii Jan 15, 2025

Choose a reason for hiding this comment

gadial Jan 20, 2025

Choose a reason for hiding this comment

alexanderivrii left a comment

Choose a reason for hiding this comment

alexanderivrii Jan 23, 2025

Choose a reason for hiding this comment

alexanderivrii Jan 23, 2025

Choose a reason for hiding this comment

alexanderivrii Jan 23, 2025

Choose a reason for hiding this comment

alexanderivrii Jan 23, 2025

Choose a reason for hiding this comment

ShellyGarion left a comment

Choose a reason for hiding this comment

ShellyGarion Jan 26, 2025 • edited Loading

Choose a reason for hiding this comment

ShellyGarion left a comment

Choose a reason for hiding this comment

gadial commented Jan 13, 2025 •

edited

Loading

coveralls commented Jan 13, 2025 •

edited

Loading

ShellyGarion Jan 26, 2025 •

edited

Loading