Skip to content
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

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

Merged
merged 3 commits into from
Jul 25, 2024
Merged

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

merged 3 commits into from
Jul 25, 2024

Conversation

lmondada
Copy link
Contributor

@lmondada lmondada commented Jul 24, 2024 •
edited
Loading

#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 lmondada requested a review from a team as a code owner July 24, 2024 15:26
@lmondada lmondada requested a review from cqc-alec July 24, 2024 15:26
@lmondada
Copy link
Contributor Author

lmondada commented Jul 24, 2024 •
edited
Loading

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

EDIT: should be good to go now.

@lmondada lmondada marked this pull request as draft July 24, 2024 15:29
@codecov Codecov
Copy link

codecov bot commented Jul 24, 2024 •
edited
Loading

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.

@lmondada lmondada force-pushed the feat/badger-multithread-py branch from e9c3275 to 3893f5a Compare July 24, 2024 15:32
@lmondada lmondada force-pushed the feat/badger-multithread-py branch from 3893f5a to 95b5a9f Compare July 24, 2024 15:33
@lmondada lmondada marked this pull request as ready for review July 24, 2024 15:33
@lmondada lmondada requested a review from doug-q July 25, 2024 07:57
doug-q
doug-q approved these changes Jul 25, 2024
View reviewed changes
Copy link
Contributor

@doug-q doug-q left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, although I would prefer a small rename

tket2-py/src/passes.rs Outdated
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>,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, will make that change. Thanks!

@lmondada 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 lmondada deleted the feat/badger-multithread-py branch July 25, 2024 11:07
This was referenced Jul 24, 2024
Closed
Closed
Merged
Merged
github-merge-queue bot pushed a commit that referenced this pull request Aug 1, 2024
@hugrbot @aborgna-q
chore(py): release (#518)
3959fc9 
🤖 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]>
github-merge-queue bot pushed a commit that referenced this pull request Aug 1, 2024
@hugrbot @doug-q
chore: release (#519)
248591b 
## 🤖 New release
* `tket2`: 0.1.0-alpha.2 -> 0.1.0
* `tket2-hseries`: 0.1.0

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

## `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>


</p></details>

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

---------

Co-authored-by: Douglas Wilson <[email protected]>
@hugrbot hugrbot mentioned this pull request Aug 1, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Aug 15, 2024
@hugrbot @ss2165
chore: release (#521)
2a547c8 
## 🤖 New release
* `tket2`: 0.1.0 -> 0.1.1
* `tket2-hseries`: 0.1.0 -> 0.1.1

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

## `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>


</p></details>

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

---------

Co-authored-by: Seyon Sivarajah <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@doug-q doug-q doug-q approved these changes

@cqc-alec cqc-alec Awaiting requested review from cqc-alec cqc-alec is a code owner automatically assigned from CQCL/tket2

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lmondada @doug-q