-
Notifications
You must be signed in to change notification settings - Fork 6
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.
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
feat: bindings for circuit cost and hash #252
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #252 +/- ##
==========================================
+ Coverage 82.65% 82.79% +0.13%
==========================================
Files 34 34
Lines 4250 4267 +17
Branches 4151 4151
==========================================
+ Hits 3513 3533 +20
+ Misses 550 548 -2
+ Partials 187 186 -1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I didn't realize "bindings" meant python, which in hindsight I should have. Definitely not feeling very expert here so maybe it's best that you've reassigned this one, but a couple of thoughts....
tket2-py/src/circuit/convert.rs
Outdated
/// :returns: The sum of all operation costs. | ||
pub fn circuit_cost<'py>(&self, cost_fn: &'py PyAny) -> PyResult<&'py PyAny> { | ||
let py = cost_fn.py(); | ||
let circ_cost = self.hugr.circuit_cost(|op| { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think some type annotations would help here. What's the result type of this lambda?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cleaned it up a bit. Hopefully it's better now.
tket2-py/src/circuit/convert.rs
Outdated
use tket_json_rs::circuit_json::SerialCircuit; | ||
|
||
use crate::rewrite::PyCircuitRewrite; | ||
|
||
use super::PyCircuitCost; | ||
|
||
/// A manager for tket 2 operations on a tket 1 Circuit. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this comment really accurate? It stores a tket2 circuit i.e. Hugr, so doesn't introduce any new way of performing tket2 operations. Something like "that converts tket1 circuits into tket2 circuits/Hugrs in order to operate on them"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Outdated comment. I replaced with a better explanation and a short example.
type Output = PyCircuitCost; | ||
|
||
fn add(self, rhs: PyCircuitCost) -> Self::Output { | ||
Python::with_gil(|py| { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am reading all of these impl
s with all of these with_gil
and thinking - this would be so much easier if we had a wrapper on the python side and did the summing there. Indeed, probably also the mapping there. I guess that's not the current setup but if we are likely to head that way then it might save us a lot of code to just do that now....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's annoying, but we're limited by the design. Once we have bindings for the hugr Walker we could revisit this.
|
||
/// Copy the circuit. | ||
pub fn __copy__(&self) -> PyResult<Self> { | ||
Ok(self.clone()) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OOI is it even possible to do something like the python shallow copy here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really, unless you add Arc
s everywhere.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
- Adds `Tk2Circuit::hash` to the python bindings. - Adds bindings for computing the cost of a circuit. - Adds tests - I split `test_bindings.py` into `test_circuit` and `test_pass`
## 🤖 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>
🤖 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>
Tk2Circuit::hash
to the python bindings.test_bindings.py
intotest_circuit
andtest_pass