feat: Represent order edges in `hugr-model` as metadata. #2027

zrho · 2025-03-25T17:43:48Z

This PR introduces metadata to encode order edges in hugr-model. The children of a dataflow region can be assigned a key via order_hint.key metadata. Then order_hint.order metadata on the dataflow region encodes order edges between keys. The PR includes the necessary import and export code in hugr-core.

codecov · 2025-03-25T17:46:10Z

Codecov Report

Attention: Patch coverage is 61.78862% with 47 lines in your changes missing coverage. Please review.

Project coverage is 83.14%. Comparing base (a16389f) to head (b034d92).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-core/src/import.rs	51.02%	8 Missing and 16 partials ⚠️
hugr-py/src/hugr/model/export.py	8.00%	23 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2027      +/-   ##
==========================================
- Coverage   83.17%   83.14%   -0.04%     
==========================================
  Files         217      217              
  Lines       42034    42130      +96     
  Branches    38232    38308      +76     
==========================================
+ Hits        34962    35027      +65     
- Misses       5113     5135      +22     
- Partials     1959     1968       +9

Flag	Coverage Δ
python	`85.40% <8.00%> (-0.40%)`	⬇️
rust	`82.91% <75.51%> (-0.01%)`	⬇️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codspeed-hq · 2025-03-25T17:48:15Z

CodSpeed Performance Report

Merging #2027 will not alter performance

_{Comparing zrho/model-order-hints (b034d92) with main (a16389f)}

Summary

✅ 21 untouched benchmarks

hugrbot · 2025-03-26T12:28:49Z

This PR contains breaking changes to the public Rust API.
Please deprecate the old API instead (if possible), or mark the PR with a ! to indicate a breaking change.

cargo-semver-checks summary


--- failure enum_variant_added: enum variant added on exhaustive enum ---

Description:
A publicly-visible enum without #[non_exhaustive] has a new variant.
      ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new
     impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_variant_added.ron

Failed in:
variant ImportError:OrderHint in /home/runner/work/hugr/hugr/PR_BRANCH/hugr-core/src/import.rs:73

hugr-core/src/envelope.rs

aborgna-q

LGTM 👍

It may be interesting to add order edges to the capnp roundtrip benchmark.
Apparently a big chunk of the export rn is taken by string formatting in make_qualified_name 🫠

aborgna-q · 2025-04-02T10:45:28Z

hugr-core/src/export.rs

+                            .map(|(successor, _)| successor)
+                            .filter(|successor| !self.hugr.get_optype(*successor).is_output());


Since order edges are always local, you should be able to cache the output node and avoid fetching the successor's optype here.

aborgna-q · 2025-04-02T10:57:27Z

hugr-model/tests/fixtures/model-order.edn

+    (meta (core.order_hint.order 1 2))
+    (meta (core.order_hint.order 1 0))
+    (meta (core.order_hint.order 2 3))
+    (meta (core.order_hint.order 0 3))


Mix in some unrelated metadata to test that everything gets preserved.

It won't since hugr-core doesn't have the concept of regions, and so only metadata on nodes is preserved so far.

Isn't this part decoding json metadata?
https://github.com/CQCL/hugr/pull/2027/files#diff-0c40879905f98b88123ea815ed5511675c496a53c78b20bf72013447d1185188R217-R238

## 🤖 New release * `hugr-model`: 0.18.1 -> 0.19.0 (⚠ API breaking changes) * `hugr-core`: 0.15.2 -> 0.15.3 ~(⚠ API breaking changes)~ * `hugr-llvm`: 0.15.2 -> 0.15.3 (✓ API compatible changes) * `hugr-passes`: 0.15.2 -> 0.15.3 (✓ API compatible changes) * `hugr`: 0.15.2 -> 0.15.3 (✓ API compatible changes) * `hugr-cli`: 0.15.2 -> 0.15.3 (✓ API compatible changes) ### ⚠ `hugr-model` breaking changes ```text --- failure enum_missing: pub enum removed or renamed --- Description: A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_missing.ron Failed in: enum hugr_model::v0::table::ExtSetPart, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:352 --- failure enum_variant_added: enum variant added on exhaustive enum --- Description: A publicly-visible enum without #[non_exhaustive] has a new variant. ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_variant_added.ron Failed in: variant Term:Func in /tmp/.tmpIpZPlW/hugr/hugr-model/src/v0/table/mod.rs:341 --- failure enum_variant_missing: pub enum variant removed or renamed --- Description: A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_variant_missing.ron Failed in: variant Term::ExtSet, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:316 variant Term::ConstFunc, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/table/mod.rs:321 variant Term::ExtSet, previously in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/ast/mod.rs:237 --- failure pub_module_level_const_missing: pub module-level const is missing --- Description: A public const is missing or renamed ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/pub_module_level_const_missing.ron Failed in: CORE_EXT_SET in file /tmp/.tmpDqJ3X7/hugr-model/src/v0/mod.rs:177 ``` ### ⚠ `hugr-core` breaking changes (⚠️ ignored ⚠️ ) ```text --- failure enum_variant_added: enum variant added on exhaustive enum --- Description: A publicly-visible enum without #[non_exhaustive] has a new variant. ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/enum_variant_added.ron Failed in: variant ImportError:OrderHint in /tmp/.tmpIpZPlW/hugr/hugr-core/src/import.rs:73 ``` <details><summary>Changelog</summary> ## `hugr-model` <blockquote> ## [0.19.0](hugr-model-v0.18.1...hugr-model-v0.19.0) - 2025-04-02 ### New Features - Python bindings for `hugr-model`. ([#1959](#1959)) - Remove extension sets from `hugr-model`. ([#2031](#2031)) - Packages in `hugr-model` and envelope support. ([#2026](#2026)) - Represent order edges in `hugr-model` as metadata. ([#2027](#2027)) </blockquote> ## `hugr-core` <blockquote> ## [0.16.0](hugr-core-v0.15.2...hugr-core-v0.16.0) - 2025-04-02 ### Documentation - Provide docs for array ops, fix bad doc for HugrView::poly_func_type ([#2021](#2021)) ### New Features - Expand SimpleReplacement API ([#1920](#1920)) - Python bindings for `hugr-model`. ([#1959](#1959)) - ReplaceTypes pass allows replacing extension types and ops ([#1989](#1989)) - Remove extension sets from `hugr-model`. ([#2031](#2031)) - Packages in `hugr-model` and envelope support. ([#2026](#2026)) - Represent order edges in `hugr-model` as metadata. ([#2027](#2027)) - add `build_expect_sum` to allow specific error messages ([#2032](#2032)) </blockquote> ## `hugr-llvm` <blockquote> ## [0.16.0](hugr-llvm-v0.15.2...hugr-llvm-v0.16.0) - 2025-04-02 ### New Features - *(hugr-llvm)* Add llvm codegen for `arithmetic.float.fpow` ([#2042](#2042)) - *(hugr-llvm)* Emit divmod and mod operations ([#2025](#2025)) </blockquote> ## `hugr-passes` <blockquote> ## [0.16.0](hugr-passes-v0.15.2...hugr-passes-v0.16.0) - 2025-04-02 ### New Features - ReplaceTypes pass allows replacing extension types and ops ([#1989](#1989)) - MakeTuple->UnpackTuple elision pass ([#2012](#2012)) - [**breaking**] Extend LowerTypes pass to linearize by inserting copy/discard ([#2018](#2018)) </blockquote> ## `hugr` <blockquote> ## [0.16.0](hugr-v0.15.2...hugr-v0.16.0) - 2025-04-02 ### Documentation - Provide docs for array ops, fix bad doc for HugrView::poly_func_type ([#2021](#2021)) ### New Features - MakeTuple->UnpackTuple elision pass ([#2012](#2012)) - [**breaking**] Extend LowerTypes pass to linearize by inserting copy/discard ([#2018](#2018)) - Expand SimpleReplacement API ([#1920](#1920)) - Python bindings for `hugr-model`. ([#1959](#1959)) - ReplaceTypes pass allows replacing extension types and ops ([#1989](#1989)) - Remove extension sets from `hugr-model`. ([#2031](#2031)) - Represent order edges in `hugr-model` as metadata. ([#2027](#2027)) - add `build_expect_sum` to allow specific error messages ([#2032](#2032)) - Packages in `hugr-model` and envelope support. ([#2026](#2026)) </blockquote> ## `hugr-cli` <blockquote> ## [0.16.0](hugr-cli-v0.15.2...hugr-cli-v0.16.0) - 2025-04-02 ### Documentation - Add usage info to hugr-cli's rustdocs ([#2044](#2044)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: Agustín Borgna <[email protected]>

#2027 ended up being breaking due to adding a new variant to an error enum missing the `non_exhaustive` marker. This (breaking) PR makes sure all error enums have the flag. BREAKING CHANGE: Marked all Error enums as `non_exhaustive`

🤖 I have created a release *beep* *boop* --- ## [0.11.5](hugr-py-v0.11.4...hugr-py-v0.11.5) (2025-04-16) ### Features * **hugr-py:** move in result classes from guppylang ([#2084](#2084)) ([b6efb03](b6efb03)) * Packages in `hugr-model` and envelope support. ([#2026](#2026)) ([a16389f](a16389f)) * Represent order edges in `hugr-model` as metadata. ([#2027](#2027)) ([09de9e3](09de9e3)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

## 🤖 New release * `hugr-model`: 0.19.0 -> 0.19.1 (✓ API compatible changes) * `hugr-core`: 0.15.3 -> 0.15.4 (✓ API compatible changes) * `hugr-llvm`: 0.15.3 -> 0.15.4 (~⚠ API breaking changes~ overwriten) * `hugr-passes`: 0.15.3 -> 0.15.4 (✓ API compatible changes) * `hugr`: 0.15.3 -> 0.15.4 (✓ API compatible changes) * `hugr-cli`: 0.15.3 -> 0.15.4 (✓ API compatible changes) ### ⚠ `hugr-llvm` breaking changes ```text --- failure trait_missing: pub trait removed or renamed --- Description: A publicly-visible trait cannot be imported by its prior path. A `pub use` may have been removed, or the trait itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.40.0/src/lints/trait_missing.ron Failed in: trait hugr_llvm::utils::array_op_builder::ArrayOpBuilder, previously in file /tmp/.tmpyTFqSG/hugr-llvm/src/utils/array_op_builder.rs:10 trait hugr_llvm::utils::ArrayOpBuilder, previously in file /tmp/.tmpyTFqSG/hugr-llvm/src/utils/array_op_builder.rs:10 ``` <details><summary>Changelog</summary> ## `hugr-model` <blockquote> ## [0.19.0](hugr-model-v0.18.1...hugr-model-v0.19.0) - 2025-04-02 ### New Features - Python bindings for `hugr-model`. ([#1959](#1959)) - Remove extension sets from `hugr-model`. ([#2031](#2031)) - Packages in `hugr-model` and envelope support. ([#2026](#2026)) - Represent order edges in `hugr-model` as metadata. ([#2027](#2027)) </blockquote> ## `hugr-core` <blockquote> ## [0.16.0](hugr-core-v0.15.3...hugr-core-v0.16.0) - 2025-04-30 ### New Features - Export the portgraph hierarchy in HugrInternals ([#2057](#2057)) - Implement Debug for generic Wire<N>s ([#2068](#2068)) - Add ExtensionOp helpers ([#2072](#2072)) - ReplaceTypes: handlers for array constants + linearization ([#2023](#2023)) - move `ArrayOpBuilder` to hugr-core ([#2115](#2115)) ### Testing - Disable IO-dependent tests when running miri ([#2123](#2123)) </blockquote> ## `hugr-llvm` <blockquote> ## [0.16.0](hugr-llvm-v0.15.3...hugr-llvm-v0.16.0) - 2025-04-30 ### New Features - move `ArrayOpBuilder` to hugr-core ([#2115](#2115)) </blockquote> ## `hugr-passes` <blockquote> ## [0.16.0](hugr-passes-v0.15.3...hugr-passes-v0.16.0) - 2025-04-30 ### New Features - ReplaceTypes: handlers for array constants + linearization ([#2023](#2023)) </blockquote> ## `hugr` <blockquote> ## [0.16.0](hugr-v0.15.3...hugr-v0.16.0) - 2025-04-30 ### New Features - Export the portgraph hierarchy in HugrInternals ([#2057](#2057)) - Implement Debug for generic Wire<N>s ([#2068](#2068)) - Add ExtensionOp helpers ([#2072](#2072)) - ReplaceTypes: handlers for array constants + linearization ([#2023](#2023)) - move `ArrayOpBuilder` to hugr-core ([#2115](#2115)) ### Testing - Disable IO-dependent tests when running miri ([#2123](#2123)) </blockquote> ## `hugr-cli` <blockquote> ## [0.15.3](hugr-cli-v0.15.2...hugr-cli-v0.15.3) - 2025-04-02 ### Documentation - Add usage info to hugr-cli's rustdocs ([#2044](#2044)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: Agustín Borgna <[email protected]>

#2027 ended up being breaking due to adding a new variant to an error enum missing the `non_exhaustive` marker. This (breaking) PR makes sure all error enums have the flag. BREAKING CHANGE: Marked all Error enums as `non_exhaustive`

zrho force-pushed the zrho/model-order-hints branch 2 times, most recently from bca1673 to e4363b6 Compare March 26, 2025 12:21

zrho force-pushed the zrho/model-order-hints branch from cd1fef9 to b20c170 Compare March 26, 2025 13:06

aborgna-q reviewed Mar 26, 2025

View reviewed changes

hugr-core/src/envelope.rs Outdated Show resolved Hide resolved

zrho force-pushed the zrho/model-order-hints branch 5 times, most recently from 9cc1bfe to 9ea72ac Compare March 26, 2025 17:38

zrho marked this pull request as ready for review March 27, 2025 17:16

zrho requested a review from a team as a code owner March 27, 2025 17:16

zrho requested a review from jake-arkinstall March 27, 2025 17:16

zrho force-pushed the zrho/model-order-hints branch from e13e8d5 to ff30662 Compare March 31, 2025 14:46

zrho requested a review from aborgna-q April 2, 2025 08:51

aborgna-q changed the base branch from main to zrho/model-package April 2, 2025 10:26

aborgna-q reviewed Apr 2, 2025

View reviewed changes

aborgna-q approved these changes Apr 2, 2025

View reviewed changes

Base automatically changed from zrho/model-package to main April 2, 2025 12:59

Import and export order edges via metadata.

b034d92

zrho force-pushed the zrho/model-order-hints branch from 8d68b5d to b034d92 Compare April 2, 2025 13:11

zrho added this pull request to the merge queue Apr 2, 2025

Merged via the queue into main with commit 09de9e3 Apr 2, 2025
23 of 25 checks passed

zrho deleted the zrho/model-order-hints branch April 2, 2025 14:30

This was referenced Apr 2, 2025

chore(main): release hugr-py 0.11.5 #2054

Merged

chore: release #2051

Merged

aborgna-q mentioned this pull request Apr 2, 2025

feat!: Mark all Error enums as non_exhaustive #2056

Merged

This was referenced Apr 8, 2025

chore: release #2058

Closed

chore: release #2065

Closed

hugrbot mentioned this pull request Apr 15, 2025

chore: release v0.19.1 #2079

Closed

hugrbot mentioned this pull request Apr 28, 2025

chore: release #2121

Merged

hugrbot mentioned this pull request Jul 3, 2025

chore(main): release hugr-py 0.13.0rc1 #2302

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Represent order edges in `hugr-model` as metadata. #2027

feat: Represent order edges in `hugr-model` as metadata. #2027

Uh oh!

zrho commented Mar 25, 2025

Uh oh!

codecov bot commented Mar 25, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Mar 25, 2025 •

edited

Loading

Uh oh!

hugrbot commented Mar 26, 2025 •

edited

Loading

Uh oh!

Uh oh!

aborgna-q left a comment

Uh oh!

aborgna-q Apr 2, 2025

Uh oh!

zrho Apr 2, 2025

Uh oh!

aborgna-q Apr 2, 2025

Uh oh!

zrho Apr 2, 2025

Uh oh!

aborgna-q Apr 2, 2025

Uh oh!

Uh oh!

Uh oh!

		.map(\|(successor, _)\| successor)
		.filter(\|successor\| !self.hugr.get_optype(*successor).is_output());

feat: Represent order edges in hugr-model as metadata. #2027

feat: Represent order edges in hugr-model as metadata. #2027

Uh oh!

Conversation

zrho commented Mar 25, 2025

Uh oh!

codecov bot commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq bot commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #2027 will not alter performance

Summary

Uh oh!

hugrbot commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

aborgna-q left a comment

Choose a reason for hiding this comment

Uh oh!

aborgna-q Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

zrho Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

aborgna-q Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

zrho Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

aborgna-q Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

feat: Represent order edges in `hugr-model` as metadata. #2027

feat: Represent order edges in `hugr-model` as metadata. #2027

codecov bot commented Mar 25, 2025 •

edited

Loading

codspeed-hq bot commented Mar 25, 2025 •

edited

Loading

hugrbot commented Mar 26, 2025 •

edited

Loading