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!: Hide lists and function tensors behind experimental flag #501

Merged
merged 3 commits into from
Sep 16, 2024

Conversation

mark-koch
Copy link
Collaborator

@mark-koch mark-koch commented Sep 15, 2024

Closes #437.

BREAKING CHANGE: Lists and function tensors are no longer available by default. guppylang.enable_experimental_features() must be called before compilation to enable them.

@mark-koch mark-koch requested a review from a team as a code owner September 15, 2024 12:31
@mark-koch mark-koch requested a review from acl-cqc September 15, 2024 12:31
@codecov-commenter
Copy link

codecov-commenter commented Sep 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.52%. Comparing base (6fdb5d6) to head (c1b8cb6).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #501      +/-   ##
==========================================
- Coverage   91.99%   91.52%   -0.48%     
==========================================
  Files          59       60       +1     
  Lines        5923     6109     +186     
==========================================
+ Hits         5449     5591     +142     
- Misses        474      518      +44     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@acl-cqc acl-cqc left a comment

Choose a reason for hiding this comment

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

Generally looks good to me, a couple of suggestions...

@@ -990,6 +996,15 @@ def instantiate_poly(node: ast.expr, ty: FunctionType, inst: Inst) -> ast.expr:
return with_type(ty, node)


def check_function_tensors_enabled(node: ast.expr | None = None) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: I wonder if the two check_xxx_enabled should live together in experimental.py

def check_function_tensors_enabled(node: ast.expr | None = None) -> None:
if not guppylang.experimental.EXPERIMENTAL_FEATURES_ENABLED:
raise GuppyError(
"Function tensors are an experimental feature. Call "
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe Use would be better than Call ?

def check_lists_enabled(loc: AstNode | None = None) -> None:
if not guppylang.experimental.EXPERIMENTAL_FEATURES_ENABLED:
raise GuppyError(
"Lists are an experimental feature and not fully supported yet. Call "
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto*2 (Call -> Use, move into experimental.py ?)

@acl-cqc
Copy link
Contributor

acl-cqc commented Sep 16, 2024

Changes enacted.

I think even "experimental features" would be good to have tests but this is better than simply not feature-flagging them ;) so merging...

@acl-cqc acl-cqc enabled auto-merge September 16, 2024 14:20
@acl-cqc acl-cqc added this pull request to the merge queue Sep 16, 2024
Merged via the queue into main with commit c867f48 Sep 16, 2024
3 checks passed
@acl-cqc acl-cqc deleted the feat/experimental branch September 16, 2024 14:25
github-merge-queue bot pushed a commit that referenced this pull request Sep 18, 2024
🤖 I have created a release *beep* *boop*
---


## [0.12.0](v0.11.0...v0.12.0)
(2024-09-18)


### ⚠ BREAKING CHANGES

* Pytket circuits loaded via a `py` expression no longer take ownership
of the passed qubits.
* Lists and function tensors are no longer available by default.
`guppylang.enable_experimental_features()` must be called before
compilation to enable them.
* The `GuppyModule` argument is now optional for all decorators and no
longer the first positional argument. Removed the explicit module
objects `builtins`, `quantum`, and `angle`.
* `quantum_functional` is now its own Guppy module and no longer
implicitly comes with `quantum`.
* Linear function arguments are now borrowed by default; removed the now
redundant `@inout` annotation

### Features

* Add functions to quantum module and make quantum_functional
independent ([#494](#494))
([0b0b1af](0b0b1af))
* Hide lists and function tensors behind experimental flag
([#501](#501))
([c867f48](c867f48))
* Make linear types [@inout](https://github.com/inout) by default; add
[@owned](https://github.com/owned) annotation
([#486](#486))
([e900c96](e900c96))
* Only lower definitions to Hugr if they are used
([#496](#496))
([cc2c8a4](cc2c8a4))
* Support implicit modules for all decorators and turn builtins into
implicit module ([#476](#476))
([cc8a424](cc8a424))
* Use inout for pytket circuits
([#500](#500))
([a980ec2](a980ec2))


### Bug Fixes

* `angle` is now a struct and emitted as a rotation
([#485](#485))
([992b138](992b138))
* Evade false positives for inout variable usage
([#493](#493))
([6fdb5d6](6fdb5d6))
* Fix redefinition of structs
([#499](#499))
([0b156e9](0b156e9))
* Initialise _checked in GuppyModule
([#491](#491))
([3dd5dd3](3dd5dd3)),
closes [#489](#489)
* use correct array ops
([#503](#503))
([720d8b8](720d8b8))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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.

Add switch to toggle experimental features
3 participants