fix: Single source of truth for circuit names, and better circuit errors #390

aborgna-q · 2024-06-07T09:56:10Z

Stores the circuit name in the FuncDefn operations instead of a "name" metadata key.
In the future we will decode tket1 circuits into funtion definitions instead of Dfg blocks, but that currently causes errors due to Allow changing extension_reqs in SiblingSubgraph::create_simple_replacement. hugr#1175.
Circuit::circuit_signature returns a FunctionType instead of a PolyFuncType, since we (currently) don't allow parametric signatures.
Improves the errors when constructing and manipulating circuits.

This work is in the path to solving #385 and #389, but we will require some fixes in hugr (CQCL/hugr#1177) before fixing the support for non-Dfg rooted circuits.

codecov · 2024-06-07T10:00:05Z

Codecov Report

Attention: Patch coverage is 68.29268% with 26 lines in your changes missing coverage. Please review.

Project coverage is 81.32%. Comparing base (39e29d4) to head (6667f69).
Report is 9 commits behind head on main.

Files	Patch %	Lines
tket2/src/circuit.rs	64.38%	22 Missing and 4 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #390      +/-   ##
==========================================
- Coverage   82.06%   81.32%   -0.75%     
==========================================
  Files          50       53       +3     
  Lines        5125     5184      +59     
  Branches     4649     4708      +59     
==========================================
+ Hits         4206     4216      +10     
- Misses        723      767      +44     
- Partials      196      201       +5

Flag	Coverage Δ
python	`96.00% <ø> (ø)`
rust	`79.84% <68.29%> (-0.80%)`	⬇️

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.

aborgna-q · 2024-06-07T10:05:21Z

Test coverage should improve once we merge #391.

doug-q

Nice. Can we include Case?

tket2/src/circuit.rs

doug-q · 2024-06-17T09:23:27Z

tket2/src/circuit.rs

-        self.hugr.get_metadata(self.parent(), "name")?.as_str()
+        let op = self.hugr.get_optype(self.parent);
+        let name = match op {
+            OpType::FuncDecl(decl) => &decl.name,


A FuncDecl can never have a child.

tket2/src/circuit.rs

doug-q · 2024-06-17T09:27:44Z

tket2/src/circuit.rs

+    let input_extensions = nodetype.input_extensions().cloned();
+    let mut optype = nodetype.into_op();
+    // Replace the parent node operation with the right operation type
+    // This must be able to process all implementers of `DataflowParent`.


doug-q · 2024-06-17T09:28:52Z

tket2/src/circuit.rs

+            }
+        }
+        OpType::FuncDefn(defn) => {
+            let mut sign: FunctionType = defn.signature.clone().try_into().map_err(|_| {


super nit, sig is a better name because sign is a word with an irrelevant meaning.

doug-q · 2024-06-17T09:30:36Z

tket2/src/rewrite/strategy.rs

-        subcirc.create_rewrite(circ, n_cx(10)).unwrap()
+        subcirc
+            .create_rewrite(circ, n_cx(10))
+            .unwrap_or_else(|e| panic!("{}", e))


I think you do this so that it prints with the Display impl rather than Debug

Yes, it's a lot nicer to read the errors if we should the Display output when doing cargo test.

Followup to #390. Fixes #389. Closes #385. ~~Blocked by CQCL/hugr#1175 Fixes support for non-`Dfg` circuits and circuits with a non-root parent: Adds a `Circuit::extract_dfg(&self)` function that extracts the circuit into a new hugr with a DFG operation at the root. In some cases, like in a CFG DataflowBlock node, this requires some changes to the definition to eliminate the output sum type. Here I only implemented it for the kind of blocks produced by guppy. We could replace the manual implementation once CQCL/hugr#818 gets implemented. With this we can now fix #389 by extracting the circuit before using it as a replacement in `SimpleReplacement::create_simple_replacement`. Replaces `DfgBuilder` with `FunctionBuilder` where possible, so we can use named circuits in the tests. (This failed before due to the bug in CircuitRewrite).

## 🤖 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 <[email protected]>

## 🤖 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 <[email protected]>

aborgna-q requested a review from ss2165 June 7, 2024 09:56

aborgna-q mentioned this pull request Jun 7, 2024

fix: Support non-DFG circuits #391

Merged

aborgna-q requested review from doug-q and removed request for ss2165 June 7, 2024 11:37

aborgna-q force-pushed the ab/circuit-names branch from c381de5 to 332cce8 Compare June 10, 2024 14:27

fix: Single source of truth for circuit names, and better circuit errors

a078798

aborgna-q force-pushed the ab/circuit-names branch from 332cce8 to a078798 Compare June 11, 2024 14:18

doug-q reviewed Jun 17, 2024

View reviewed changes

Support Case, and other minor review comments

6667f69

aborgna-q requested a review from doug-q June 17, 2024 10:29

doug-q approved these changes Jun 17, 2024

View reviewed changes

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

Merged via the queue into main with commit f18aa4d Jun 17, 2024
15 of 16 checks passed

aborgna-q deleted the ab/circuit-names branch June 17, 2024 11:27

hugrbot mentioned this pull request Jun 17, 2024

chore: release #409

Closed

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

fix: Single source of truth for circuit names, and better circuit errors #390

fix: Single source of truth for circuit names, and better circuit errors #390

aborgna-q commented Jun 7, 2024

codecov bot commented Jun 7, 2024 •

edited

Loading

aborgna-q commented Jun 7, 2024

doug-q left a comment

doug-q Jun 17, 2024

doug-q Jun 17, 2024

doug-q Jun 17, 2024

doug-q Jun 17, 2024

aborgna-q Jun 17, 2024

fix: Single source of truth for circuit names, and better circuit errors #390

fix: Single source of truth for circuit names, and better circuit errors #390

Conversation

aborgna-q commented Jun 7, 2024

codecov bot commented Jun 7, 2024 • edited Loading

Codecov Report

aborgna-q commented Jun 7, 2024

doug-q left a comment

Choose a reason for hiding this comment

doug-q Jun 17, 2024

Choose a reason for hiding this comment

doug-q Jun 17, 2024

Choose a reason for hiding this comment

doug-q Jun 17, 2024

Choose a reason for hiding this comment

doug-q Jun 17, 2024

Choose a reason for hiding this comment

aborgna-q Jun 17, 2024

Choose a reason for hiding this comment

codecov bot commented Jun 7, 2024 •

edited

Loading