feat: Define a wire tracker for the new pytket decoder #1036

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

Jump to bottom

Merged

aborgna-q merged 12 commits into main from ab/decoder-wire-tracker

Aug 15, 2025

Collaborator

aborgna-q commented Aug 13, 2025

Defines a WireTracker struct for the pytket decoder framework.

It keeps track of wires that have been added to the HUGR being created along with which qubit/bit/parameter elements each of them carries (wires may carry multiple, see PytketTypeTranslator in ::serialize::pytket::extensions.
The tracker lets us associate new wires with registers/parameters, and updates previous references so they know they don't have the latest pytket register value.

In the future we'll expand this tracker to let us do automatic type translations (e.g. unpacking a tuple), as defined by the extension decoders.

Also adds a new Tk1DecodeError that will be used by the decoder framework.

Depends on #1035

aborgna-q requested a review from ss2165

August 13, 2025 16:44

aborgna-q requested a review from a team as a code owner

August 13, 2025 16:44

codecov bot commented Aug 13, 2025 •

edited

Loading

Codecov Report

❌ Patch coverage is 39.70037% with 322 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.03%. Comparing base (99f568b) to head (ae40c62).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
tket/src/serialize/pytket/decoder/wires.rs	28.39%	292 Missing and 3 partials ⚠️
tket/src/serialize/pytket.rs	52.77%	17 Missing ⚠️
tket/src/serialize/pytket/decoder/tracked_elem.rs	88.37%	10 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1036      +/-   ##
==========================================
- Coverage   79.74%   78.03%   -1.72%     
==========================================
  Files          97       99       +2     
  Lines       11674    12208     +534     
  Branches    11395    11929     +534     
==========================================
+ Hits         9309     9526     +217     
- Misses       1734     2049     +315     
- Partials      631      633       +2

Flag	Coverage Δ
python	`81.00% <ø> (ø)`
rust	`77.96% <39.70%> (-1.75%)`	⬇️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

aborgna-q requested a review from Copilot

August 13, 2025 16:48

This comment was marked as resolved.

Sign in to view

aborgna-q force-pushed the ab/decoder-wire-tracker branch from 420e3ac to fbb74ac Compare

August 13, 2025 17:03

aborgna-q mentioned this pull request

chore: Organize decoder code #1035

Merged

Base automatically changed from ab/decoder-lopaded-param to main

August 14, 2025 11:07

aborgna-q added 5 commits

August 14, 2025 12:13


          feat: Add a LoadedParam struct for the pytket decoder

4a8c73a


          Delete the previous LoadedParameter


          feat: Define a wire tracker for the new pytket decoder

5e26e5c


          Actually compile the wire tracker module

6e42675


          Simplify wire_inputs_for_command logic

0bb0c43

aborgna-q force-pushed the ab/decoder-wire-tracker branch from a92a1d2 to 0bb0c43 Compare

August 14, 2025 11:13

aborgna-q mentioned this pull request

feat!: Reworked pytket decoder framework #1030

Merged

3 tasks


          rename Tk1DecodeError to PytketDecodeError

ss2165 reviewed

View reviewed changes

tket/src/serialize/pytket/decoder/wires.rs Outdated

+                  }
+              }
+              /// Tracked wires to a pytket operation.

Member

ss2165 Aug 14, 2025

not sure what this docstring means

tket/src/serialize/pytket/decoder/wires.rs Outdated

+                  /// Return an iterator over the wires and their types.
+                  ///
+                  /// This returns the wires as-is, without any additional conversions.
+                  /// If you need to retrieve a specific wire type, use TODO

Member

ss2165 Aug 14, 2025

TODO?

Collaborator Author

aborgna-q Aug 14, 2025

Leftover comment from the automated type translation work. Removed.

tket/src/serialize/pytket/decoder/wires.rs Outdated

+                  /// Returns the tracked qubit elements in the set of wires as an array.
+                  #[inline]
+                  pub fn qubits_arr<const N: usize>(

Member

ss2165 Aug 14, 2025

no array equivalent for bits?

do all of these need to be public?

Collaborator Author

aborgna-q Aug 14, 2025

This is the main object that implementors of decoders interact with when doing operation translations, so I tried to add some useful helpers.

This one (in contrast to wires_arr) is just a collect_arr wrapper, so I removed it.

tket/src/serialize/pytket/decoder/wires.rs Outdated

+              /// operation, all previous references to it become "outdated".
+              #[derive(Debug, Clone, Default)]
+              pub struct WireTracker {
+                  /// A list of tracked wires, with their type and list of

Member

ss2165 Aug 14, 2025

list or map? outdated docstring?

tket/src/serialize/pytket/decoder/wires.rs Outdated

+                  ///
+                  /// * `hugr` - The hugr to add the wires to.
+                  /// * `args` - The list of pytket element ids to map to wires.
+                  /// * `operation` - The name of the operation being decoded, used for error reporting.

Member

ss2165 Aug 14, 2025

if it is only used for error reporting shouldn't it be added as context by the calling function instead?

Collaborator Author

aborgna-q Aug 14, 2025

Made a change copying the model ImportError / ImportErrorInner structure,
so we can add the context later and remove these parameters.

tket/src/serialize/pytket/decoder/wires.rs Show resolved Hide resolved

aborgna-q added 3 commits

August 14, 2025 18:05


          Merge remote-tracking branch 'origin/main' into ab/decoder-wire-tracker

a6d7839


          review comments

b2606b9


          Add a context wrapper to the DecoderError, drop operation string ar…

e998a12

…guments

aborgna-q requested a review from ss2165

August 14, 2025 17:46


          Replace wire_inputs_for_command with a way simpler find_typed_wires

be07895

Collaborator Author

aborgna-q commented Aug 15, 2025

@ss2165 I ended up going and adding a last commit simplifying the tracker logic after the review. Sorry 😬

aborgna-q requested a review from Copilot

August 15, 2025 08:55

This comment was marked as resolved.

Sign in to view


          doc typo

44ab992

ss2165 approved these changes

View reviewed changes

tket/src/serialize/pytket/decoder/wires.rs Show resolved Hide resolved

tket/src/serialize/pytket/decoder/tracked_elem.rs Outdated

Comment on lines 40 to 43

                   reg: Arc<PytketRegister>,
+                  /// The hash of the pytket register for this tracked element, used to
+                  /// speed up hashing and equality checks.
+                  reg_hash: RegisterHash,

Member

ss2165 Aug 15, 2025

ideally these two should be in a struct by themselves - they're not independent

Collaborator Author

aborgna-q Aug 15, 2025

I originally intended to put this inside the Arc, but RegisterHash is a single byte so it's cheaper to just have it here.
I guess we could add an intermediary

pub struct PytketResource {
    element: Arc<tket_json_rs::register::ElementId>,
    hash: RegisterHash,
}

I'll add a TODO


          Add TODO

ae40c62

aborgna-q enabled auto-merge

August 15, 2025 14:36

aborgna-q added this pull request to the merge queue

Merged via the queue into main with commit 2466ee2

19 of 20 checks passed

aborgna-q deleted the ab/decoder-wire-tracker branch

August 15, 2025 14:44

This was referenced Aug 14, 2025

chore(py): release tket-py 0.12.2 #1006

Merged

chore: release #1028

Merged

github-merge-queue bot pushed a commit that referenced this pull request


          feat!: Reworked pytket decoder framework (#1030)

6a1e604

- Adds a `PytketDecoder` trait that let us extend the decoding framework
to external extensions.
- Translations are no longer 1-to-1 between pytket commands and hugr
ops, the decoding call has access to a hugr builder and its context.
- Allows tracking wires with complex/composite types. We don't provide
helpers to convert types yet, it's up to the extension emitter to look
at the incoming wire types. (Note: I splitted this change to a previous
PR, #1036)


TODO:
- [x] Implement the decoder trait for all standard extensions.
- [x] Fix remaining test errors.
- [ ] Add a nicer guide for writing extension traits in the module docs.

BREAKING CHANGE: Split pytket encoder/decoder errors into separate
structs.

github-merge-queue bot pushed a commit that referenced this pull request


          chore: release (#1028)

d01fedd

## 🤖 New release

* `tket`: 0.13.2 -> 0.14.0 (✓ API compatible changes)
* `tket-qsystem`: 0.18.1 -> 0.19.0 (✓ API compatible changes)

<details><summary><i><b>Changelog</b></i></summary><p>

## `tket`

<blockquote>

##
[0.14.0](tket-v0.13.2...tket-v0.14.0)
- 2025-08-18

### New Features

- [**breaking**] Allow PytketTypeTranslators to translate nested types
([#1038](#1038))
- Define a wire tracker for the new pytket decoder
([#1036](#1036))
- [**breaking**] Reworked pytket decoder framework
([#1030](#1030))
- [**breaking**] Use qsystem encoder/decoders in tket-py
([#1041](#1041))
- [**breaking**] Avoid eagerly cloning SerialCircuits when decoding from
pytket ([#1048](#1048))

### Refactor

- [**breaking**] Rename tk2 encoder names to tket
([#1037](#1037))
</blockquote>

## `tket-qsystem`

<blockquote>

##
[0.19.0](tket-qsystem-v0.18.1...tket-qsystem-v0.19.0)
- 2025-08-18

### New Features

- Add emitters for tket-qsystem
([#1039](#1039))
- [**breaking**] Avoid eagerly cloning SerialCircuits when decoding from
pytket ([#1048](#1048))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

github-merge-queue bot pushed a commit that referenced this pull request


          chore(py): release tket-py 0.12.2 (#1006)

f1ee0a4

🤖 I have created a release *beep* *boop*
---


##
[0.12.2](tket-py-v0.12.1...tket-py-v0.12.2)
(2025-08-19)


### Features

* Define a wire tracker for the new pytket decoder
([#1036](#1036))
([2466ee2](2466ee2))
* Support qsystem native operations when loading pytket circuits
([#1041](#1041))
([88c5c79](88c5c79))
* **tket-py:** Create BadgerOptimiser from arbitrary Rewriters
([#1022](#1022))
([a975c1d](a975c1d)),
closes [#1021](#1021)


### Documentation

* Update README badges
([#1004](#1004))
([d609bf5](d609bf5))

---
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: Agustín Borgna <agustin.borgna@quantinuum.com>

croyzor pushed a commit that referenced this pull request


          chore(py): release tket-py 0.12.2 (#1006)

1e73789

🤖 I have created a release *beep* *boop*
---


##
[0.12.2](tket-py-v0.12.1...tket-py-v0.12.2)
(2025-08-19)


### Features

* Define a wire tracker for the new pytket decoder
([#1036](#1036))
([2466ee2](2466ee2))
* Support qsystem native operations when loading pytket circuits
([#1041](#1041))
([88c5c79](88c5c79))
* **tket-py:** Create BadgerOptimiser from arbitrary Rewriters
([#1022](#1022))
([a975c1d](a975c1d)),
closes [#1021](#1021)


### Documentation

* Update README badges
([#1004](#1004))
([d609bf5](d609bf5))

---
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: Agustín Borgna <agustin.borgna@quantinuum.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet