feat: Load `pytket` circuit as a function definition #672

tatiana-s · 2024-11-29T10:54:10Z

Closes #657, however the following limitations still exist which are covered by further issues:

Improve handling of measurements in pytket circuit functions #669: ~~Classical bits and measurements aren't currently supported as this requires some checks related to ownership and return values.~~ They are supported but without taking ownership.
Load pytket functions without explicit function stub #670: It would be nice to not have to provide an explicit function stub for the circuit and also have load_pytket method which infers it.
Support arrays in pytket function stubs #671: It would also be nice to be able to provide arrays of qubits in the function stub.

codecov-commenter · 2024-12-03T13:22:00Z

Codecov Report

Attention: Patch coverage is 91.66667% with 11 lines in your changes missing coverage. Please review.

Project coverage is 92.63%. Comparing base (50f71b9) to head (0864123).

Files with missing lines	Patch %	Lines
guppylang/definition/pytket_circuits.py	91.11%	8 Missing ⚠️
guppylang/decorator.py	80.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #672      +/-   ##
==========================================
- Coverage   92.75%   92.63%   -0.13%     
==========================================
  Files          68       69       +1     
  Lines        7720     7833     +113     
==========================================
+ Hits         7161     7256      +95     
- Misses        559      577      +18

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

mark-koch

Looks good! Mostly just some nits and suggestions.

It looks like the coverage report doesn't include the test you've written for some reason. It should be running with tket2 installed, so no idea what's going on there.

Speaking of tests, could you also add some error tests for every GuppyError that is thrown. See the tests/error directory

guppylang/checker/errors/py_errors.py

guppylang/definition/pytket_circuits.py

mark-koch · 2024-12-03T15:47:59Z

guppylang/definition/pytket_circuits.py

+                # TODO: Error if hugr isn't FuncDefn?
+                if node_data and isinstance(node_data.op, FuncDefn):


Yes, we should throw an InternalGuppyError

mark-koch · 2024-12-03T15:52:35Z

guppylang/definition/pytket_circuits.py

+                            input_types.remove(Bool)
+
+            else:
+                raise GuppyError(PytketNotCircuit(self.defined_at))


I'd prefer to just raise this as a Python TypeError in guppy.pytket. No need to wait until compilation to throw this error

mark-koch · 2024-12-03T16:01:29Z

guppylang/definition/pytket_circuits.py

+        # Negative index slicing doesn't work when num_returns is 0.
+        if num_returns == 0:
+            return CallReturnWires(
+                regular_returns=[],
+                inout_returns=list(call[0:]),
+            )
+        else:
+            # Circuit function returns are the other way round to Guppy returns.
+            return CallReturnWires(
+                regular_returns=list(call[-num_returns:]),
+                inout_returns=list(call[:-num_returns]),
+            )


Consider doing

Suggested change

# Negative index slicing doesn't work when num_returns is 0.

if num_returns == 0:

return CallReturnWires(

regular_returns=[],

inout_returns=list(call[0:]),

)

else:

# Circuit function returns are the other way round to Guppy returns.

return CallReturnWires(

regular_returns=list(call[-num_returns:]),

inout_returns=list(call[:-num_returns]),

)

num_inouts = len(list(call)) - num_returns

return CallReturnWires(

regular_returns=list(call[inout_returns:]),

inout_returns=list(call[:inout_returns]),

)

to avoid the 0 edge case

mark-koch · 2024-12-03T16:09:44Z

tests/integration/test_pytket_circuits.py

+    def foo(q: qubit) -> None:
+        result = guppy_circ(q)


Suggested change

def foo(q: qubit) -> None:

result = guppy_circ(q)

def foo(q: qubit) -> bool:

return guppy_circ(q)

This way, validation checks that the bool is wired correctly

tatiana-s · 2024-12-04T16:49:18Z

The reason coverage is not taking the tests into account is because -- extra pytket isn't actually installing tket2 - there is some issue with clashing versions when trying to install tket2 which is why it was commented out I assume.

guppylang/definition/pytket_circuits.py

guppylang/checker/errors/py_errors.py

mark-koch

Looks good, thank you!

🤖 I have created a release *beep* *boop* --- ## [0.14.0](v0.13.1...v0.14.0) (2024-12-19) ### ⚠ BREAKING CHANGES * Lists in `py(...)` expressions are now turned into Guppy arrays instead of lists. * `dirty_qubit` function removed * measure_return renamed to `project_z` ### Features * add `maybe_qubit` stdlib function ([#705](#705)) ([a49f70e](a49f70e)), closes [#627](#627) * add measure_array and discard_array quantum function ([#710](#710)) ([3ad49ff](3ad49ff)) * Add method to load pytket circuit without function stub ([#712](#712)) ([ee1e3de](ee1e3de)) * Add Option type to standard library ([#696](#696)) ([45ea6b7](45ea6b7)) * Allow generic nat args in statically sized ranges ([#706](#706)) ([f441bb8](f441bb8)), closes [#663](#663) * Array comprehension ([#613](#613)) ([fdc0526](fdc0526)), closes [#614](#614) [#616](#616) [#612](#612) * Implicit coercion of numeric types ([#702](#702)) ([df4745b](df4745b)), closes [#701](#701) * Load `pytket` circuit as a function definition ([#672](#672)) ([b21b7e1](b21b7e1)) * Make arrays iterable ([#632](#632)) ([07b9871](07b9871)) * qsystem std functions with updated primitives ([#679](#679)) ([b0f041f](b0f041f)) * remove dirty_qubit ([#698](#698)) ([78e366b](78e366b)) * Turn py expression lists into arrays ([#697](#697)) ([d52a00a](d52a00a)) * Unpacking assignment of iterable types with static size ([#688](#688)) ([602e243](602e243)) * update to hugr 0.10 and tket2 0.6 ([#725](#725)) ([63ea7a7](63ea7a7)) ### Bug Fixes * Accept non-negative int literals and py expressions as nats ([#708](#708)) ([a93d4fe](a93d4fe)), closes [#704](#704) * Allow borrowing inside comprehensions ([#723](#723)) ([02b6ab0](02b6ab0)), closes [#719](#719) * Detect unsupported default arguments ([#659](#659)) ([94ac7e3](94ac7e3)), closes [#658](#658) * docs build command ([#729](#729)) ([471b74c](471b74c)) * Ensure `int`s can be treated as booleans ([#709](#709)) ([6ef6d60](6ef6d60)), closes [#681](#681) * Fix array execution bugs ([#731](#731)) ([0f6ceaa](0f6ceaa)) * Fix implicit modules in IPython shells ([#662](#662)) ([4ecb5f2](4ecb5f2)), closes [#661](#661) * Properly report error for unsupported constants ([#724](#724)) ([d0c2da4](d0c2da4)), closes [#721](#721) * Properly report errors for unsupported expressions ([#692](#692)) ([7f24264](7f24264)), closes [#691](#691) * remove use of deprecated Ellipsis ([#699](#699)) ([b819a84](b819a84)) ### Documentation * Fix docs build ([#700](#700)) ([684f485](684f485)), closes [#680](#680) * fix README.md and quickstart.md ([#654](#654)) ([abb0221](abb0221)) --- 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: Seyon Sivarajah <[email protected]>

tatiana-s added 13 commits November 25, 2024 17:33

Add empty classes for pytket circuit definitions

a9e4090

Start implementing pytket circuit decorator

76ca28c

Run format and check

76fb0a9

Implement parse for circuit signature stub

dfc7da6

Start implementing conversion to hugr function definition

188aa0c

Add basic test

ce222b0

Extract compiled function methods

4efe329

Implement hugr insertion of circuit function

86c89d0

Add false positive typo check fix

64176fc

Change hugr function name and add more tests

273600d

Fix typing errors

787d515

Fix check and adjust test

8164111

Adjust test

994e0ac

tatiana-s assigned tatiana-s and mark-koch Nov 29, 2024

tatiana-s requested a review from a team as a code owner November 29, 2024 10:54

tatiana-s requested a review from aborgna-q November 29, 2024 10:54

tatiana-s unassigned tatiana-s and mark-koch Nov 29, 2024

tatiana-s requested review from mark-koch and removed request for aborgna-q November 29, 2024 10:54

tatiana-s added 3 commits December 2, 2024 17:32

Attempts to manipulate function signature to make measurements work

f25f702

Modify input node to match function definition

c72c519

Merge remote-tracking branch 'origin/main' into ts/circuit-functions

e1f7110

mark-koch reviewed Dec 3, 2024

View reviewed changes

tatiana-s added 2 commits December 4, 2024 15:59

Address comments

ab20ac5

Fix sig mismatch error test

1d417e5

tatiana-s requested a review from mark-koch December 4, 2024 16:50

tatiana-s added 2 commits December 4, 2024 17:07

Add tket2 dependency

d41198b

Remove test skips

a56ab6b

mark-koch reviewed Dec 5, 2024

View reviewed changes

guppylang/definition/pytket_circuits.py Outdated Show resolved Hide resolved

guppylang/definition/pytket_circuits.py Outdated Show resolved Hide resolved

guppylang/checker/errors/py_errors.py Outdated Show resolved Hide resolved

tatiana-s added 2 commits December 6, 2024 09:42

Address comments

99ee621

Fix error test

0864123

tatiana-s requested a review from mark-koch December 6, 2024 09:55

mark-koch approved these changes Dec 6, 2024

View reviewed changes

tatiana-s added this pull request to the merge queue Dec 6, 2024

Merged via the queue into main with commit b21b7e1 Dec 6, 2024
3 checks passed

tatiana-s deleted the ts/circuit-functions branch December 6, 2024 13:46

hugrbot mentioned this pull request Dec 6, 2024

chore(main): release 0.14.0 #655

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Load `pytket` circuit as a function definition #672

feat: Load `pytket` circuit as a function definition #672

tatiana-s commented Nov 29, 2024 •

edited

Loading

codecov-commenter commented Dec 3, 2024 •

edited

Loading

mark-koch left a comment

mark-koch Dec 3, 2024

mark-koch Dec 3, 2024

This comment was marked as outdated.

mark-koch Dec 3, 2024

mark-koch Dec 3, 2024

tatiana-s commented Dec 4, 2024

mark-koch left a comment

		# TODO: Error if hugr isn't FuncDefn?
		if node_data and isinstance(node_data.op, FuncDefn):

feat: Load pytket circuit as a function definition #672

feat: Load pytket circuit as a function definition #672

Conversation

tatiana-s commented Nov 29, 2024 • edited Loading

codecov-commenter commented Dec 3, 2024 • edited Loading

Codecov Report

mark-koch left a comment

Choose a reason for hiding this comment

mark-koch Dec 3, 2024

Choose a reason for hiding this comment

mark-koch Dec 3, 2024

Choose a reason for hiding this comment

This comment was marked as outdated.

mark-koch Dec 3, 2024

Choose a reason for hiding this comment

mark-koch Dec 3, 2024

Choose a reason for hiding this comment

tatiana-s commented Dec 4, 2024

mark-koch left a comment

Choose a reason for hiding this comment

feat: Load `pytket` circuit as a function definition #672

feat: Load `pytket` circuit as a function definition #672

tatiana-s commented Nov 29, 2024 •

edited

Loading

codecov-commenter commented Dec 3, 2024 •

edited

Loading