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.

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(hugr-py): builder ops separate from serialised ops #1140

Merged
merged 5 commits into from
Jun 4, 2024
Merged

Conversation

ss2165
Copy link
Member

@ss2165 ss2165 commented May 30, 2024

also move the "number of input wires" interface convenience to calls on ops

"builder ops" are currently very similar to the serialised ones - this will change once builder types are separated from serialised types

@ss2165 ss2165 requested a review from a team as a code owner May 30, 2024 12:41
@ss2165 ss2165 requested review from cqc-alec and removed request for a team May 30, 2024 12:41
Copy link

codecov bot commented May 30, 2024

Codecov Report

Attention: Patch coverage is 90.74074% with 10 lines in your changes missing coverage. Please review.

Project coverage is 87.06%. Comparing base (72d3b03) to head (ac56552).
Report is 1 commits behind head on main.

Files Patch % Lines
hugr-py/src/hugr/_ops.py 88.75% 9 Missing ⚠️
hugr-py/src/hugr/serialization/ops.py 93.75% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1140      +/-   ##
==========================================
- Coverage   87.09%   87.06%   -0.03%     
==========================================
  Files          93       94       +1     
  Lines       19079    19153      +74     
  Branches    18353    18353              
==========================================
+ Hits        16617    16676      +59     
- Misses       1613     1628      +15     
  Partials      849      849              
Flag Coverage Δ
python 89.25% <90.74%> (-0.15%) ⬇️

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.

@ss2165 ss2165 changed the title feat: builder ops separate from serialised ops feat(hugr-py): builder ops separate from serialised ops May 30, 2024
@ss2165 ss2165 force-pushed the ss/op-hier branch 2 times, most recently from a8e97a7 to 666a34f Compare May 30, 2024 12:53
@ss2165 ss2165 marked this pull request as draft May 30, 2024 15:48
@ss2165 ss2165 force-pushed the ss/op-hier branch 2 times, most recently from bcc9af1 to 6fbe393 Compare May 31, 2024 12:10
Base automatically changed from ss2165/pybuild to main May 31, 2024 16:31
@ss2165 ss2165 removed the request for review from cqc-alec June 3, 2024 08:52
@ss2165 ss2165 force-pushed the ss/op-hier branch 2 times, most recently from c2c8528 to 3499776 Compare June 4, 2024 15:34
@ss2165 ss2165 requested a review from aborgna-q June 4, 2024 15:36
@ss2165 ss2165 marked this pull request as ready for review June 4, 2024 15:36
Copy link
Collaborator

@aborgna-q aborgna-q left a comment

Choose a reason for hiding this comment

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

Nice 👍

Still no docs 🫠

@@ -529,3 +557,6 @@ class OpDef(ConfiguredBaseModel, populate_by_name=True):
)

tys_model_rebuild(dict(classes))

#
import hugr._ops as ops # noqa: E402 # needed to avoid circular imports
Copy link
Collaborator

Choose a reason for hiding this comment

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

Ugh -.-

This re-exports hugr._ops as hugr.serialization.ops.ops, so it ends up as part of the public API.
You should leave it as

from hugr import _ops

for now.


class Op(Protocol):
@property
def num_out(self) -> int | None:
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is unset for many op definitions (Input, SerWrap, Custom, DFG)

Copy link
Member Author

Choose a reason for hiding this comment

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

it can't be known in general - but can be for many of those! (which I've added). Am unsure about Custom but I've added it for now. It should be left as the default None for SerWrap.

@ss2165
Copy link
Member Author

ss2165 commented Jun 4, 2024

docs are quite far down the list in the tracking issue #486 😬

@ss2165 ss2165 added this pull request to the merge queue Jun 4, 2024
Merged via the queue into main with commit 342eda3 Jun 4, 2024
20 checks passed
@ss2165 ss2165 deleted the ss/op-hier branch June 4, 2024 16:29
github-merge-queue bot pushed a commit that referenced this pull request Jul 3, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.3.0](hugr-py-v0.2.1...hugr-py-v0.3.0)
(2024-07-03)


### ⚠ BREAKING CHANGES

* * `add_child_op`(`_with_parent`), etc., gone; use
`add_child_node`(`_with_parent`) with an (impl Into-)OpType.
    * `get_nodetype` gone - use `get_optype`.
    * `NodeType` gone - use `OpType` directly. 
    * Various (Into<)Option<ExtensionSet> params removed from builder
    methods especially {cfg_,dfg_}builder.
    * `input_extensions` removed from serialization schema.
* the Signature class is gone, but it's not clear how or why you might
have been using it...
* TailLoop node and associated builder functions now require specifying
an ExtensionSet; extension/validate.rs deleted; some changes to Hugrs
validated/rejected when the `extension_inference` feature flag is turned
on
* Type::validate takes extra bool (allow_rowvars); renamed
{FunctionType, PolyFuncType}::(validate=>validate_var_len).

### Features

* Allow "Row Variables" declared as List&lt;Type&gt;
([#804](#804))
([3ea4834](3ea4834))
* **hugr-py:** add builders for Conditional and TailLoop
([#1210](#1210))
([43569a4](43569a4))
* **hugr-py:** add CallIndirect, LoadFunction, Lift, Alias
([#1218](#1218))
([db09193](db09193)),
closes [#1213](#1213)
* **hugr-py:** add values and constants
([#1203](#1203))
([f7ea178](f7ea178)),
closes [#1202](#1202)
* **hugr-py:** automatically add state order edges for inter-graph edges
([#1165](#1165))
([5da06e1](5da06e1))
* **hugr-py:** builder for function definition/declaration and call
([#1212](#1212))
([af062ea](af062ea))
* **hugr-py:** builder ops separate from serialised ops
([#1140](#1140))
([342eda3](342eda3))
* **hugr-py:** CFG builder
([#1192](#1192))
([c5ea47f](c5ea47f)),
closes [#1188](#1188)
* **hugr-py:** define type hierarchy separate from serialized
([#1176](#1176))
([10f4c42](10f4c42))
* **hugr-py:** only require input type annotations when building
([#1199](#1199))
([2bb079f](2bb079f))
* **hugr-py:** python hugr builder
([#1098](#1098))
([23408b5](23408b5))
* **hugr-py:** store children in node weight
([#1160](#1160))
([1cdaeed](1cdaeed)),
closes [#1159](#1159)
* **hugr-py:** ToNode interface to treat builders as nodes
([#1193](#1193))
([1da33e6](1da33e6))
* Validate Extensions using hierarchy, ignore input_extensions, RIP
inference ([#1142](#1142))
([8bec8e9](8bec8e9))


### Bug Fixes

* Add some validation for const nodes
([#1222](#1222))
([c05edd3](c05edd3))
* **hugr-py:** more ruff lints + fix some typos
([#1246](#1246))
([f158384](f158384))
* **py:** get rid of pydantic config deprecation warnings
([#1084](#1084))
([52fcb9d](52fcb9d))


### Documentation

* **hugr-py:** add docs link to README
([#1259](#1259))
([d2a9148](d2a9148))
* **hugr-py:** build and publish docs
([#1253](#1253))
([902fc14](902fc14))
* **hugr-py:** docstrings for builder
([#1231](#1231))
([3e4ac18](3e4ac18))


### Code Refactoring

* Remove "Signature" from hugr-py
([#1186](#1186))
([65718f7](65718f7))
* Remove NodeType and input_extensions
([#1183](#1183))
([ea5213d](ea5213d))

---
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: hugrbot <[email protected]>
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants