feat: guppy → pytket conversion #407

aborgna-q · 2024-06-12T11:14:45Z

Adds support for converting flat pure functions defined in guppy into pytket circuits. See the example in test_guppy.py.

This PR just adds a lower_to_pytket pass that currently only runs the tuple erasure from #406.

codecov · 2024-06-17T15:24:59Z

Codecov Report

Attention: Patch coverage is 72.22222% with 15 lines in your changes missing coverage. Please review.

Project coverage is 81.07%. Comparing base (425d6b4) to head (e23b055).

Files	Patch %	Lines
tket2/src/passes/pytket.rs	0.00%	11 Missing ⚠️
tket2/src/serialize/pytket.rs	81.25%	2 Missing and 1 partial ⚠️
tket2/src/serialize/pytket/encoder.rs	66.66%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #407   +/-   ##
=======================================
  Coverage   81.06%   81.07%           
=======================================
  Files          55       57    +2     
  Lines        5382     5411   +29     
  Branches     4906     4926   +20     
=======================================
+ Hits         4363     4387   +24     
- Misses        812      816    +4     
- Partials      207      208    +1

Flag	Coverage Δ
python	`97.52% <100.00%> (+1.51%)`	⬆️
rust	`79.45% <50.00%> (-0.17%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

ss2165

Looks good, just a couple of questions. Mainly worried the angles will lead to confusing examples for other people.

ss2165 · 2024-06-18T08:30:13Z

tket2-py/test/test_guppy.py

+        q0: qubit,
+        q1: qubit,
+    ) -> tuple[qubit, qubit]:  # pragma: no cover
+        q0 = phased_x(q0, py(math.pi / 2), py(-math.pi / 2))


tket1 has angles in fractions of pi, are these angles converted correctly?

Good catch. That was missing in the encoder/decoder.

Now we translate between radians and half-turns when converting hugrs to pytket circuits.

ss2165 · 2024-06-18T08:33:06Z

tket2-py/test/test_guppy.py

+    hugr = module.compile()
+    json = hugr.to_raw().to_json()
+
+    # Load it from the JSON string
+    circ = Tk2Circuit.from_guppy_json(json, "my_func")


these three lines probably belong in a function, in _circuit.py orsomething

There's a couple reasons for keeping this explicit for the moment:

Without CQCL/guppylang#246, we need to keep an explicit reference to the hugr if we want to create multiple circuits from the same module.
Once that's published we'll be able to create functions from the function definition itself;

from_guppy(my_func: guppy.Definition) -> Tk2Circuit

But more importantly, tket2 only has a dev-dependency on guppy.
To avoid cyclic dependencies, we cannot expose from_guppy in the library API.
In the future I imagine guppy may import tket2 and expose to_circuit methods on modules and functions.

I added a utility functions for testing, but we won't be able to expose it in the tket2 api.

makes sense, thanks for the explanation

aborgna-q · 2024-06-18T10:34:50Z

tket2/src/serialize/pytket/tests.rs

+    let point2 = h.add_load_value(ConstF64::new(0.2 * std::f64::consts::PI));
+    let point3 = h.add_load_value(ConstF64::new(0.3 * std::f64::consts::PI));


I was surprised this didn't cause precision errors.
The parameter still gets encoded as "0.2 + 0.3" in the test below.

They don't show locally for some reason

ss2165

awesome, very close now!

🤖 I have created a release *beep* *boop* --- ## 0.1.0 (2024-06-28) ### ⚠ BREAKING CHANGES * require `hugr-0.5.0` * Replaced `tket2.circuit.OpConvertError` with `tket2.circuit.TK1ConvertError` in the python lib. * Moved `tket2::json` to `tket2::serialize::pytket` * Replaced the `Circuit` trait with a wrapper struct. * This is a breaking change to the compiled rewriter serialisation format. ### Features * Add a "progress timeout" to badger ([#259](#259)) ([556cf64](556cf64)) * Add missing typing hints ([#352](#352)) ([4990613](4990613)) * bindings for circuit cost and hash ([#252](#252)) ([85ce5f9](85ce5f9)) * drop pyo3 core dep ([#355](#355)) ([9f7d415](9f7d415)) * EccRewriter bindings ([#251](#251)) ([97e2e0a](97e2e0a)) * guppy → pytket conversion ([#407](#407)) ([8c5a487](8c5a487)) * Implement `PyErr` conversion locally in `tket2-py` ([#258](#258)) ([3e1a68d](3e1a68d)) * init tket2-hseries ([#368](#368)) ([61e7535](61e7535)) * pauli propagation use case example ([#333](#333)) ([f46973c](f46973c)) * **py:** Allow using `Tk2Op`s in the builder ([#436](#436)) ([aed8651](aed8651)) * Support any ops in portmatching ([#293](#293)) ([6b05a05](6b05a05)) * **tket2-py:** Bind the `lower_to_pytket` pass in python ([#439](#439)) ([8208324](8208324)) * Use tket1 and tket2 circuits interchangeably everywhere ([#243](#243)) ([eac7acf](eac7acf)) * Utilities for loading compiled guppy circuits ([#393](#393)) ([028779a](028779a)) ### Bug Fixes * failed importlib import ([#254](#254)) ([b077660](b077660)) * induced cycles in depth optimisation ([#264](#264)) ([68c9ff2](68c9ff2)), closes [#253](#253) * Make native py modules behave like python's ([#212](#212)) ([4220038](4220038)), closes [#209](#209) * pytest failing to find `tket2` in CI ([#367](#367)) ([a9df8e6](a9df8e6)) * **tket2-py:** Replace `with_hugr` helpers with `with_circ`, keeping the circuit parent. ([#438](#438)) ([b77b3cb](b77b3cb)) ### Documentation * Add some example notebooks for the python package. ([#443](#443)) ([4ed276c](4ed276c)), closes [#434](#434) * Update tket2-py readme ([6c8f18a](6c8f18a)) ### Code Refactoring * Rename `tket2::json` into `tket2::serialize::pytket` ([#392](#392)) ([93e611c](93e611c)) * Replace Circuit trait with a struct ([#370](#370)) ([ec5dd22](ec5dd22)) * Simplify tket1 conversion errors ([#408](#408)) ([b0b8aff](b0b8aff)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: Agustin Borgna <agustin.borgna@quantinuum.com>

## 🤖 New release * `tket2`: 0.1.0-alpha.2 -> 0.1.0 * `tket2-hseries`: 0.1.0 <details><summary>Changelog</summary> ## `tket2` <blockquote> ## [0.1.0](tket2-v0.1.0-alpha.2...tket2-v0.1.0) - 2024-08-01 ### Bug Fixes - Single source of truth for circuit names, and better circuit errors ([#390](#390)) - Support non-DFG circuits ([#391](#391)) - Portmatching not matching const edges ([#444](#444)) - Pattern matcher discriminating on opaqueOp description ([#441](#441)) - `extract_dfg` inserting the output node with an invalid child order ([#442](#442)) - Recompile ecc sets after [#441](#441) ([#484](#484)) ### Documentation - Update tket2-py readme ([#431](#431)) - Better error reporting in portmatching ([#437](#437)) - Improved multi-threading docs for Badger ([#495](#495)) ### New Features - `Circuit::operations` ([#395](#395)) - tuple unpack rewrite ([#406](#406)) - guppy → pytket conversion ([#407](#407)) - Drop linear bits, improve pytket encoding/decoding ([#420](#420)) - *(py)* Allow using `Tk2Op`s in the builder ([#436](#436)) - Initial support for `TailLoop` as circuit parent ([#417](#417)) - Support tuple unpacking with multiple unpacks ([#470](#470)) - Partial tuple unpack ([#475](#475)) - [**breaking**] Compress binary ECCs using zlib ([#498](#498)) - Add timeout options and stats to Badger ([#496](#496)) - Expose advanced Badger timeout options to tket2-py ([#506](#506)) ### Refactor - [**breaking**] Simplify tket1 conversion errors ([#408](#408)) - Cleanup tket1 serialized op structures ([#419](#419)) ### Testing - Add coverage for Badger split circuit multi-threading ([#505](#505)) </blockquote> ## `tket2-hseries` <blockquote> ## [0.1.0](https://github.com/CQCL/tket2/releases/tag/tket2-hseries-v0.1.0) - 2024-08-01 ### New Features - [**breaking**] init tket2-hseries ([#368](#368)) - *(tket2-hseries)* Add `tket2.futures` Hugr extension ([#471](#471)) - Add lazify-measure pass ([#482](#482)) - add results extensions ([#494](#494)) - *(tket2-hseries)* [**breaking**] Add `HSeriesPass` ([#487](#487)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Co-authored-by: Douglas Wilson <douglas.wilson@quantinuum.com>

## 🤖 New release * `tket2`: 0.1.0 -> 0.1.1 * `tket2-hseries`: 0.1.0 -> 0.1.1 <details><summary>Changelog</summary> ## `tket2` <blockquote> ## [0.1.0](tket2-v0.1.0-alpha.2...tket2-v0.1.0) - 2024-08-01 ### Bug Fixes - Single source of truth for circuit names, and better circuit errors ([#390](#390)) - Support non-DFG circuits ([#391](#391)) - Portmatching not matching const edges ([#444](#444)) - Pattern matcher discriminating on opaqueOp description ([#441](#441)) - `extract_dfg` inserting the output node with an invalid child order ([#442](#442)) - Recompile ecc sets after [#441](#441) ([#484](#484)) ### Documentation - Update tket2-py readme ([#431](#431)) - Better error reporting in portmatching ([#437](#437)) - Improved multi-threading docs for Badger ([#495](#495)) ### New Features - `Circuit::operations` ([#395](#395)) - tuple unpack rewrite ([#406](#406)) - guppy → pytket conversion ([#407](#407)) - Drop linear bits, improve pytket encoding/decoding ([#420](#420)) - *(py)* Allow using `Tk2Op`s in the builder ([#436](#436)) - Initial support for `TailLoop` as circuit parent ([#417](#417)) - Support tuple unpacking with multiple unpacks ([#470](#470)) - Partial tuple unpack ([#475](#475)) - [**breaking**] Compress binary ECCs using zlib ([#498](#498)) - Add timeout options and stats to Badger ([#496](#496)) - Expose advanced Badger timeout options to tket2-py ([#506](#506)) ### Refactor - [**breaking**] Simplify tket1 conversion errors ([#408](#408)) - Cleanup tket1 serialized op structures ([#419](#419)) ### Testing - Add coverage for Badger split circuit multi-threading ([#505](#505)) </blockquote> ## `tket2-hseries` <blockquote> ## [0.1.1](tket2-hseries-v0.1.0...tket2-hseries-v0.1.1) - 2024-08-15 ### New Features - *(tket2-hseries)* make result operation internals public ([#542](#542)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Co-authored-by: Seyon Sivarajah <seyon.sivarajah@cambridgequantum.com>

aborgna-q mentioned this pull request Jun 6, 2024

tracking issue: Lower guppy-generated Circuits into pytket #377

Closed

14 tasks

aborgna-q force-pushed the ab/guppy-to-pytket branch from 3c7b81d to 5746252 Compare June 17, 2024 12:26

aborgna-q force-pushed the ab/tuple-rewrite branch from dd5f32e to 99fab1b Compare June 17, 2024 12:26

aborgna-q force-pushed the ab/guppy-to-pytket branch from 5746252 to 78ea83b Compare June 17, 2024 12:51

aborgna-q force-pushed the ab/tuple-rewrite branch 2 times, most recently from b0a5dfd to 75dba2f Compare June 17, 2024 14:46

aborgna-q force-pushed the ab/guppy-to-pytket branch from 78ea83b to d0bf44a Compare June 17, 2024 14:48

Base automatically changed from ab/tuple-rewrite to main June 17, 2024 15:14

aborgna-q force-pushed the ab/guppy-to-pytket branch from d0bf44a to 3d5d2cb Compare June 17, 2024 15:17

feat: convert guppy programs into pytket circuits

865afdb

aborgna-q force-pushed the ab/guppy-to-pytket branch from 3d5d2cb to 865afdb Compare June 17, 2024 15:20

aborgna-q requested a review from ss2165 June 17, 2024 15:25

Ignore coverage in guppy function

ea37aa8

aborgna-q force-pushed the ab/guppy-to-pytket branch from 1c11951 to ea37aa8 Compare June 17, 2024 15:50

Test alternative no-coverage marker

6f30b43

ss2165 reviewed Jun 18, 2024

View reviewed changes

Convert between radians and half-turns when encoding pytket circs

a4bab6e

aborgna-q commented Jun 18, 2024

View reviewed changes

guppy_to_circuit test helper

649356f

aborgna-q requested a review from ss2165 June 18, 2024 10:44

Fix mypy errors

e23b055

They don't show locally for some reason

ss2165 approved these changes Jun 18, 2024

View reviewed changes

aborgna-q added this pull request to the merge queue Jun 18, 2024

Merged via the queue into main with commit 8c5a487 Jun 18, 2024
15 of 16 checks passed

aborgna-q deleted the ab/guppy-to-pytket branch June 18, 2024 12:41

This was referenced Jun 17, 2024

chore: release #409

Closed

chore(main): release tket2-py 0.1.0 #361

Closed

hugrbot mentioned this pull request Jun 26, 2024

chore(main): release tket2-py 0.1.0a1 #435

Merged

hugrbot mentioned this pull request Aug 1, 2024

chore: release #519

Merged

hugrbot mentioned this pull request Aug 1, 2024

chore: release #521

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: guppy → pytket conversion #407

feat: guppy → pytket conversion #407

aborgna-q commented Jun 12, 2024 •

edited

Loading

codecov bot commented Jun 17, 2024 •

edited

Loading

ss2165 left a comment

ss2165 Jun 18, 2024

aborgna-q Jun 18, 2024

ss2165 Jun 18, 2024

aborgna-q Jun 18, 2024

aborgna-q Jun 18, 2024

ss2165 Jun 18, 2024

aborgna-q Jun 18, 2024 •

edited

Loading

ss2165 left a comment

		let point2 = h.add_load_value(ConstF64::new(0.2 * std::f64::consts::PI));
		let point3 = h.add_load_value(ConstF64::new(0.3 * std::f64::consts::PI));

feat: guppy → pytket conversion #407

feat: guppy → pytket conversion #407

Conversation

aborgna-q commented Jun 12, 2024 • edited Loading

codecov bot commented Jun 17, 2024 • edited Loading

Codecov Report

ss2165 left a comment

Choose a reason for hiding this comment

ss2165 Jun 18, 2024

Choose a reason for hiding this comment

aborgna-q Jun 18, 2024

Choose a reason for hiding this comment

ss2165 Jun 18, 2024

Choose a reason for hiding this comment

aborgna-q Jun 18, 2024

Choose a reason for hiding this comment

aborgna-q Jun 18, 2024

Choose a reason for hiding this comment

ss2165 Jun 18, 2024

Choose a reason for hiding this comment

aborgna-q Jun 18, 2024 • edited Loading

Choose a reason for hiding this comment

ss2165 left a comment

Choose a reason for hiding this comment

aborgna-q commented Jun 12, 2024 •

edited

Loading

codecov bot commented Jun 17, 2024 •

edited

Loading

aborgna-q Jun 18, 2024 •

edited

Loading