feat: Add a "progress timeout" to badger #259
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #259 +/- ##
==========================================
- Coverage 83.25% 83.22% -0.04%
==========================================
Files 34 34
Lines 4240 4232 -8
Branches 4124 4116 -8
==========================================
- Hits 3530 3522 -8
Misses 523 523
Partials 187 187 ☔ View full report in Codecov by Sentry. |
ss2165
approved these changes
Nov 24, 2023
tket2-py/src/passes.rs
Outdated
| log_dir: Option<PathBuf>, | ||
| rebase: Option<bool>, | ||
| ) -> PyResult<&'py PyAny> { | ||
| // Default parameter values | ||
| let rebase = rebase.unwrap_or(true); | ||
| let max_threads = max_threads.unwrap_or(num_cpus::get().try_into().unwrap()); | ||
| let timeout = timeout.unwrap_or(30); | ||
| let progress_timeout = progress_timeout.unwrap_or(timeout.div_ceil(2)); |
There was a problem hiding this comment.
so default is actually half timeout? it says no timeout in the comment
There was a problem hiding this comment.
Changed it to disabled by default.
aborgna-q
force-pushed
the
feat/badger-prog-timeout
branch
from
07dff34
to
3833e66
Compare
ss2165
pushed a commit
that referenced
this pull request
Dec 8, 2023
Stops the optimisation when we haven't found any new best results in a while.
github-merge-queue bot
pushed a commit
that referenced
this pull request
May 24, 2024
## 🤖 New release * `tket2`: 0.1.0-alpha.1 <details><summary><i><b>Changelog</b></i></summary><p> ## `tket2` <blockquote> ## [0.0.0-alpha.1](https://github.com/CQCL/tket2/releases/tag/tket2-v0.0.0-alpha.1) - 2024-05-24 ### Bug Fixes - Check for rewrite composition in badger ([#255](#255)) - induced cycles in depth optimisation ([#264](#264)) - Encode opaque symbolic constants ([#273](#273)) - Correctly detect custom ops by name ([#281](#281)) - Track input linear units in `Command` ([#310](#310)) - Don't convert tket2 measurements into tket1 ops ([#331](#331)) ### Documentation - Expand the main module and README docs ([#298](#298)) ### New Features - add angle type to tket2 extension ([#231](#231)) - bindings for circuit cost and hash ([#252](#252)) - Implement `PyErr` conversion locally in `tket2-py` ([#258](#258)) - Add a "progress timeout" to badger ([#259](#259)) - [**breaking**] Add lexicographic cost ([#270](#270)) - rewrite tracing ([#267](#267)) - Move pre/post rewrite cost to the RewriteStrategy API ([#276](#276)) - [**breaking**] Lexicographic cost fn ([#277](#277)) - Return rewrite strategies as a generator ([#275](#275)) - add qalloc, qfree, reset ops ([#284](#284)) - [**breaking**] Support any ops in portmatching ([#293](#293)) - Add `PatternMatch::nodes` and `subcircuit` + matching example ([#299](#299)) - Use `IncomingPort` and `OutgoingPort` instead of `Port` where possible. ([#296](#296)) - expose Tk2Op name ([#307](#307)) ### Refactor - Move tket2 code to a workspace member ([#210](#210)) - Restructure the python code ([#211](#211)) - s/taso/badger/ ([#228](#228)) - Move python bindings from `tket2` to `tket2-py` ([#235](#235)) - rename t2op ([#256](#256)) ### Testing - Add small parallel badger test ([#237](#237)) - fix non-deterministic badger test ([#245](#245)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Agustin Borgna <agustin.borgna@quantinuum.com>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 28, 2024
🤖 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>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jul 25, 2024
#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`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Stops the optimisation when we haven't found any new best results in a while.