[feature] AutoQASM: Free parameters #762

laurencap · 2023-10-26T01:14:46Z

Issue #, if available:
Part 1 of #757

Description of changes:

This allows statements such as rx(0, FreeParameter("theta")) in AutoQASM programs.

When converted to OpenQASM, the resulting program has an input statement, such as input float[32] theta;.

This PR will be followed by these additional works to complete the feature:

Support expressions of parameters
Support other types besides float
Support free parameters in conditional statements
Documentation -- when the feature is more complete

Testing done:
New test file!

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

I have read the CONTRIBUTING doc
I used the commit message format described in CONTRIBUTING
I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

I have added tests that prove my fix is effective or that my feature works (if appropriate)
I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Fixup lint

codecov · 2023-10-27T21:13:07Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a079c52) 100.00% compared to head (c4ae77a) 100.00%.
Report is 9 commits behind head on feature/autoqasm.

Additional details and impacted files

@@                Coverage Diff                 @@
##           feature/autoqasm      #762   +/-   ##
==================================================
  Coverage            100.00%   100.00%           
==================================================
  Files                   162       162           
  Lines                  9655      9653    -2     
  Branches               2077      2076    -1     
==================================================
- Hits                   9655      9653    -2

Files	Coverage Δ
src/braket/devices/local_simulator.py	`100.00% <100.00%> (ø)`
src/braket/experimental/autoqasm/api.py	`100.00% <100.00%> (ø)`
...braket/experimental/autoqasm/instructions/gates.py	`100.00% <100.00%> (ø)`
...experimental/autoqasm/instructions/instructions.py	`100.00% <100.00%> (ø)`
...rc/braket/experimental/autoqasm/program/program.py	`100.00% <100.00%> (ø)`

... and 3 files with indirect coverage changes

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

test/unit_tests/braket/experimental/autoqasm/test_parameters.py

rmshaffer

🎉

test/unit_tests/braket/experimental/autoqasm/test_parameters.py

rmshaffer · 2023-10-30T15:07:39Z

src/braket/experimental/autoqasm/instructions/gates.py

@@ -52,14 +55,14 @@ def cnot(
 def cphaseshift(
    control: QubitIdentifierType,
    target: QubitIdentifierType,
-    angle: float,
+    angle: Union[float, FreeParameterExpression],


I wonder if there is a good way to define an alias for this union type. Seems like user-defined gates should also technically be using this as a type hint, and we wouldn't want users to have to copy this. Does it make sense to have an AngleIdentifierType that we expose as aq.Angle (just like aq.Qubit for QubitIdentifierType)? Or is that too specific - are there other types that should be supported with this pattern too? Gates can only take angles, but in general input parameters to a program can be other types.

It's a good question. Aaron pointed out that we'll want to migrate from float to OpenQASM angles, because gates are not supposed to take floats.

It actually makes the code less clean to include the FreeParameterExpression -- there's a type check somewhere that gate parameters should only be floats, so we have to do extra work to ignore the FreeParameterExpression.

I feel like allowing the type hint to just hint at what the concrete value should eventually be is probably best in user code. The ParameterExpressions bit feels noisy and unproductive, even if it's true.

Ah I'm noticing now that gate_calibrations produce signatures with angle, so we should prioritize consistency using angles everywhere. I didn't realize they are already used in some places

Aaron pointed out that we'll want to migrate from float to OpenQASM angles, because gates are not supposed to take floats.

This is just a consideration for the IR we generate. Users will still certainly provide floats

Yeah, gate definitions in OQ3 must use angle params, so we do use that for @aq.gate and @aq.gate_calibration. OQ3 allows implicitly casting float to angle, so technically everything else could use float and be fine, I think. But I also agree that if possible we should try to avoid exposing that to users, who just want to use float everywhere.

Ah okay, wasn't aware of the implicit cast. That's good news

ajberdy · 2023-10-30T17:10:03Z

test/unit_tests/braket/experimental/autoqasm/test_parameters.py

+@aq.main
+def simple_parametric():
+    rx(0, FreeParameter("theta"))
+    measure(0)


I'm a bit confused by this ux over something like

@aq.main def simple_parametric(theta): rx(0, theta) measure(0)

It seems like ^ is simpler and gives users a spot to designate inputs as ints etc

I believe this already works with this implementation. User can then call either simple_parametric(pi/2) or simple_parametric(FreeParameter("theta")) depending on whether they want a fixed or parameterized program.

rmshaffer · 2023-10-30T17:27:54Z

test/unit_tests/braket/experimental/autoqasm/test_parameters.py

+    measurements = _test_parametric_on_local_sim(simple_parametric(), {"theta": 3.14})
+    assert 0 not in measurements["__bit_0__"]


I didn't notice this on the first pass, but all of these tests which check measurement results after rotating by 3.14 are going to have some low probability of failure. Can you use pi instead?

feature: Add support for FreeParameters

2a8bfca

laurencap mentioned this pull request Oct 26, 2023

[feature] AutoQASM: Support for free parameters #761

Closed

5 tasks

laurencap self-assigned this Oct 26, 2023

Add new tests and fix broken tests

047451c

Fixup lint

laurencap force-pushed the free-parameters branch from f3f87ff to 047451c Compare October 26, 2023 01:21

laurencap added 4 commits October 26, 2023 16:29

Add more tests

3896cc4

Scope down to only floats

1dd5754

Fix subroutine argument processing

a77de15

Scope out conditions

b7c11e2

laurencap force-pushed the free-parameters branch from abe42fd to b7c11e2 Compare October 27, 2023 17:26

laurencap added 2 commits October 27, 2023 15:08

Fix lint

d65f91b

Replace type | type with Union

e90fd53

Fix coverage, remove dup test

0f1f1a2

laurencap marked this pull request as ready for review October 28, 2023 16:56

laurencap requested a review from a team as a code owner October 28, 2023 16:56

laurencap requested review from rmshaffer and yitchen-tim October 28, 2023 16:56

yitchen-tim reviewed Oct 30, 2023

View reviewed changes

test/unit_tests/braket/experimental/autoqasm/test_parameters.py Show resolved Hide resolved

rmshaffer approved these changes Oct 30, 2023

View reviewed changes

Add test for gate calibrations

c4ae77a

laurencap merged commit eca82e6 into amazon-braket:feature/autoqasm Oct 30, 2023
22 checks passed

ajberdy reviewed Oct 30, 2023

View reviewed changes

rmshaffer reviewed Oct 30, 2023

View reviewed changes

laurencap mentioned this pull request Nov 1, 2023

AutoQASM: Add support for FreeParameter as gate arguments #757

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feature] AutoQASM: Free parameters #762

[feature] AutoQASM: Free parameters #762

laurencap commented Oct 26, 2023 •

edited

Loading

codecov bot commented Oct 27, 2023 •

edited

Loading

rmshaffer left a comment

rmshaffer Oct 30, 2023

laurencap Oct 30, 2023

laurencap Oct 30, 2023

ajberdy Oct 30, 2023

rmshaffer Oct 30, 2023

laurencap Oct 30, 2023

ajberdy Oct 30, 2023

rmshaffer Oct 30, 2023

rmshaffer Oct 30, 2023

		measurements = _test_parametric_on_local_sim(simple_parametric(), {"theta": 3.14})
		assert 0 not in measurements["__bit_0__"]

[feature] AutoQASM: Free parameters #762

[feature] AutoQASM: Free parameters #762

Conversation

laurencap commented Oct 26, 2023 • edited Loading

Merge Checklist

General

Tests

codecov bot commented Oct 27, 2023 • edited Loading

Codecov Report

rmshaffer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laurencap commented Oct 26, 2023 •

edited

Loading

codecov bot commented Oct 27, 2023 •

edited

Loading