feat: pauli propagation use case example #333

ss2165 · 2024-05-03T14:18:29Z

Add bindings to emulate python builder - intent is to replace this with a pure python builder.

Add "CircuitBuilder" like utilities to assist appending operations to qubits.

Use the above to demonstrate pauli propagation through a circuit using exhaustive rewrite rule application.

Add some type annotations for circuit bindings, should ideally be replicated for other modules

codecov · 2024-05-03T14:22:49Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.02%. Comparing base (2f1d1a1) to head (ef8251a).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #333      +/-   ##
==========================================
+ Coverage   84.99%   85.02%   +0.02%     
==========================================
  Files          35       36       +1     
  Lines        4444     4553     +109     
  Branches     4292     4292              
==========================================
+ Hits         3777     3871      +94     
- Misses        487      503      +16     
+ Partials      180      179       -1

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

aborgna-q

Awesome.

We'll rework this interface soon™, but this is a cool proof of concept for the API.

aborgna-q · 2024-05-03T14:28:19Z

tket2-py/tket2/tket2/_circuit.pyi

+    """A Tket2 built-in operation."""
+
+    H = 1
+    CX = 2


Add all the others? At least the ones that appear in build.py.

Suggested change

CX = 2

CX = auto()

T = auto()

S = auto()

X = auto()

Y = auto()

Z = auto()

Tdg = auto()

Sdg = auto()

ZZMax = auto()

Measure = auto()

RzF64 = auto()

RxF64 = auto()

PhasedX = auto()

ZZPhase = auto()

AngleAdd = auto()

CZ = auto()

TK1 = auto()

QAlloc = auto()

QFree = auto()

Reset = auto()

It's annoying that the values are required. They do not exist on the rust side.

aborgna-q · 2024-05-03T14:43:07Z

tket2-py/tket2/circuit/build.py

+# Some common operations
+
+QAlloc = CustomOp("quantum.tket2", "QAlloc", [], [QB_T])
+QFree = CustomOp("quantum.tket2", "QFree", [QB_T], [])
+Measure = CustomOp("quantum.tket2", "Measure", [QB_T], [QB_T, BOOL_T])
+Not = CustomOp("logic", "Not", [BOOL_T], [BOOL_T])
+
+
+@dataclass(frozen=True)
+class H(Command):
+    qubit: int
+    gate_name = "H"
+    n_qb = 1
+
+    def qubits(self) -> list[int]:
+        return [self.qubit]
+


There's a bit of a mix here of Operations with no corresponding command, and commands with no first-level operation definition.

No need to actually add them here since this is a prototype, but maybe add a comment mentioning the difference?

🤖 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>

ss2165 added 25 commits May 3, 2024 09:39

feat: bind circuit builder

a1ca9fb

add_op dataflow addition wrapper

1b24ce4

use opaque custom ops

801d9d0

add type stubs

8d5263b

clippy

3276914

query node op

85206a2

bind Wire

9c4bc40

use tket2 quantum extension

a8c4b1a

demo propagation

6557dd8

use builder for rules

3a1e72a

extend by command API

5d486e5

bind simple rewrite specification

a7832c1

from_coms convenience

a53e6d3

add alloc/free test

27c80a2

bind types

40cba00

ToCustom protocol

6a3198d

simplify Gate/Command and add measure

4bc3afb

simplify class structure further

b70a517

add not op

4d6cfe8

propagate through measure

4eb6e65

bind some hugr queries to allow pauli string reading

4561c9b

bind mermaid string

210950a

clean up and do some TODOs

7841c1a

add docstrings to stubs

8a9c55b

refactor in to sensible modules

a99316c

ss2165 requested a review from aborgna-q May 3, 2024 14:18

add ascii art to explain measure text

a67e022

aborgna-q approved these changes May 3, 2024

View reviewed changes

add nissing enum variants

ae6971b

comment highlighting what can be a command

ef8251a

ss2165 added this pull request to the merge queue May 3, 2024

Merged via the queue into main with commit f46973c May 3, 2024
11 checks passed

ss2165 deleted the feat/circ-build branch May 3, 2024 15:14

github-actions bot mentioned this pull request May 23, 2024

chore(tket2): release v0.1.0-alpha.1 #357

Merged

hugrbot mentioned this pull request May 24, 2024

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: pauli propagation use case example #333

feat: pauli propagation use case example #333

ss2165 commented May 3, 2024

codecov bot commented May 3, 2024 •

edited

Loading

aborgna-q left a comment

aborgna-q May 3, 2024

aborgna-q May 3, 2024

-    CX = 2
+    CX = auto()
+    T = auto()
+    S = auto()
+    X = auto()
+    Y = auto()
+    Z = auto()
+    Tdg = auto()
+    Sdg = auto()
+    ZZMax = auto()
+    Measure = auto()
+    RzF64 = auto()
+    RxF64 = auto()
+    PhasedX = auto()
+    ZZPhase = auto()
+    AngleAdd = auto()
+    CZ = auto()
+    TK1 = auto()
+    QAlloc = auto()
+    QFree = auto()
+    Reset = auto()

feat: pauli propagation use case example #333

feat: pauli propagation use case example #333

Conversation

ss2165 commented May 3, 2024

codecov bot commented May 3, 2024 • edited Loading

Codecov Report

aborgna-q left a comment

Choose a reason for hiding this comment

aborgna-q May 3, 2024

Choose a reason for hiding this comment

aborgna-q May 3, 2024

Choose a reason for hiding this comment

codecov bot commented May 3, 2024 •

edited

Loading