feat: Expose advanced Badger timeout options to tket2-py #506

lmondada · 2024-07-24T15:26:04Z

#496 introduced a new timeout criterion for Badger based on the number of circuits seen during optimisation. This was not consistently exposed to the Python API.

Fly-by: The progress_timeout timeout criterion that was added in #259 was also not exposed properly. This PR also fixes this.

The timeout option max_circuit_cnt is now called max_circuit_count.

lmondada · 2024-07-24T15:29:35Z

I see I'm missing the arguments in one more function signature. Will add it now.

EDIT: should be good to go now.

codecov · 2024-07-24T15:30:32Z

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.49%. Comparing base (573d0ba) to head (fcb1194).

Files	Patch %	Lines
badger-optimiser/src/main.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #506   +/-   ##
=======================================
  Coverage   83.49%   83.49%           
=======================================
  Files          64       64           
  Lines        6647     6647           
  Branches     6126     6126           
=======================================
  Hits         5550     5550           
  Misses        817      817           
  Partials      280      280

Flag	Coverage Δ
python	`96.73% <ø> (ø)`
rust	`82.37% <50.00%> (ø)`

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.

doug-q

Looks good, although I would prefer a small rename

doug-q · 2024-07-25T08:01:38Z

tket2-py/src/passes.rs

 fn badger_optimise<'py>(
    circ: &Bound<'py, PyAny>,
    optimiser: &PyBadgerOptimiser,
    max_threads: Option<NonZeroUsize>,
    timeout: Option<u64>,
    progress_timeout: Option<u64>,
+    max_circuit_cnt: Option<usize>,


I prefer max_circuit_count, as marginally less vulgar. you may disagree

yes, will make that change. Thanks!

🤖 I have created a release *beep* *boop* --- <details><summary>tket2-py: 0.2.0</summary> ## [0.2.0](tket2-py-v0.1.0...tket2-py-v0.2.0) (2024-08-01) ### ⚠ BREAKING CHANGES * increased minimum required version of hugr to 0.9.0 * `.rwr` ECC files generated with older versions are no longer supported. Please recompile them, or compress the file with `zstd`. ### Features * Add timeout options and stats to Badger ([#496](#496)) ([32a9885](32a9885)) * Compress binary ECCs using zlib ([#498](#498)) ([d9a713c](d9a713c)) * Expose advanced Badger timeout options to tket2-py ([#506](#506)) ([fe7d40e](fe7d40e)) * Move the compiled eccs to a separate package ([#517](#517)) ([7247cc6](7247cc6)) ### Bug Fixes * Recompile ecc sets after [#441](#441) ([#484](#484)) ([1122fa4](1122fa4)) ### Miscellaneous Chores * bump hugr version to 0.10.0 ([#508](#508)) ([eca258b](eca258b)) </details> <details><summary>tket2-eccs: 0.1.0</summary> ## 0.1.0 (2024-08-01) ### Features * Move the compiled eccs to a separate package ([#517](#517)) ([7247cc6](7247cc6)) </details> --- 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 <[email protected]>

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

lmondada requested a review from a team as a code owner July 24, 2024 15:26

lmondada requested a review from cqc-alec July 24, 2024 15:26

lmondada marked this pull request as draft July 24, 2024 15:29

lmondada force-pushed the feat/badger-multithread-py branch from e9c3275 to 3893f5a Compare July 24, 2024 15:32

feat: Expose advanced timeout options to tket2-py

95b5a9f

lmondada force-pushed the feat/badger-multithread-py branch from 3893f5a to 95b5a9f Compare July 24, 2024 15:33

lmondada marked this pull request as ready for review July 24, 2024 15:33

Merge branch 'main' into feat/badger-multithread-py

824bcb5

lmondada requested a review from doug-q July 25, 2024 07:57

doug-q approved these changes Jul 25, 2024

View reviewed changes

change max_circuit_cnt to max_circuit_count

fcb1194

lmondada added this pull request to the merge queue Jul 25, 2024

Merged via the queue into main with commit fe7d40e Jul 25, 2024
16 of 17 checks passed

lmondada deleted the feat/badger-multithread-py branch July 25, 2024 11:07

This was referenced Jul 24, 2024

chore(main): release tket2-py 0.2.0 #502

Closed

chore: release #409

Closed

chore: release main #518

Merged

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: Expose advanced Badger timeout options to tket2-py #506

feat: Expose advanced Badger timeout options to tket2-py #506

lmondada commented Jul 24, 2024 •

edited

Loading

lmondada commented Jul 24, 2024 •

edited

Loading

codecov bot commented Jul 24, 2024 •

edited

Loading

doug-q left a comment

doug-q Jul 25, 2024

lmondada Jul 25, 2024

feat: Expose advanced Badger timeout options to tket2-py #506

feat: Expose advanced Badger timeout options to tket2-py #506

Conversation

lmondada commented Jul 24, 2024 • edited Loading

lmondada commented Jul 24, 2024 • edited Loading

codecov bot commented Jul 24, 2024 • edited Loading

Codecov Report

doug-q left a comment

Choose a reason for hiding this comment

doug-q Jul 25, 2024

Choose a reason for hiding this comment

lmondada Jul 25, 2024

Choose a reason for hiding this comment

lmondada commented Jul 24, 2024 •

edited

Loading

lmondada commented Jul 24, 2024 •

edited

Loading

codecov bot commented Jul 24, 2024 •

edited

Loading