Update for pyQuil v3 #215

ameyer-rigetti · 2021-08-09T22:44:40Z

Description

Update code and tests for pyQuil v3

Closes #213

Checklist

The above description motivates these changes.
There is a unit test that covers these changes.
The code respects the API separation discussed in .github/CONTRIBUTING.md.
Relevant references and equations are cited using our standard reference style.
All new and existing tests pass locally and on PR checks.
Parameters have type hints with PEP 484 syntax.
Functions and classes have useful sphinx-style docstrings.
(New Feature) The docs and example notebooks have been updated accordingly.
The changelog (docs/source/changes.rst) has a description of this change.

ameyer-rigetti · 2021-08-09T22:52:38Z

I'm not sure why, but Semaphore can't seem to find pyQuil v3.0.0 when running the pip install:

Collecting pyquil<4.0.0,>=3.0.0 (from -r requirements.txt (line 1))
  Could not find a version that satisfies the requirement pyquil<4.0.0,>=3.0.0 (from -r requirements.txt (line 1)) (from versions: 0.0.1, 0.0.2, 0.0.3, 0.1.0, 1.0.0, 1.1.1, 1.1.2, 1.1.3, 1.1.4, 1.2.0, 1.3.0, 1.3.1, 1.3.2, 1.4.0, 1.4.1, 1.4.2, 1.4.3, 1.4.4, 1.4.5, 1.4.6, 1.5.0, 1.5.1, 1.6.0, 1.6.1, 1.6.2, 1.6.3, 1.7.0, 1.8.0, 1.9.0, 2.0.0b1, 2.0.0b3, 2.0.0b4, 2.0.0b5, 2.0.0b6, 2.0.0b7, 2.0.0b8, 2.0.0, 2.1.0, 2.1.1, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.5.0, 2.5.1, 2.5.2, 2.6.0, 2.7.0, 2.7.1, 2.7.2, 2.8.0, 2.9.0, 2.9.1, 2.10.0, 2.11.0, 2.12.0, 2.13.0, 2.14.0, 2.15.0, 2.16.0, 2.17.0, 2.18.0, 2.19.0, 2.20.0, 2.21.0, 2.22.0, 2.23.0, 2.23.1, 2.23.2, 2.24.0, 2.25.0, 2.26.0, 2.27.0, 2.28.0, 2.28.1, 2.28.2)
No matching distribution found for pyquil<4.0.0,>=3.0.0 (from -r requirements.txt (line 1))

Locally:
Tests pass (without --runslow). I've updated the slow tests too and will try to run them, though they're quite slow.

docs/examples/qubit_spectroscopy_cz_ramsey.ipynb

genos · 2021-08-09T22:55:27Z

Assuming all the tests etc. pass (no CI here?) LGTM 👍

forest/benchmarking/quantum_volume.py

ameyer-rigetti · 2021-08-09T23:18:03Z

Assuming all the tests etc. pass (no CI here?) LGTM 👍

@genos Thanks :) CI seems to run on Semaphore for this repo, but I don't know why it can't pick up the latest version of pyQuil...

Maybe someone who has access to the Semaphore account can take a peek?

dbanty

Looks good to my untrained eyes 😅

dbanty · 2021-08-10T14:33:45Z

docs/examples/robust_phase_estimation.ipynb

-    "from pyquil.device import gates_in_isa\n",
-    "from pyquil.noise import decoherence_noise_with_asymmetric_ro, _decoherence_noise_model\n",
-    "# noise_model = decoherence_noise_with_asymmetric_ro(gates=gates_in_isa(qc.device.get_isa()), p00=0.92, p11=.87)\n",
+    "from pyquil.noise import decoherence_noise_with_asymmetric_ro, _decoherence_noise_model, _get_qvm_noise_supported_gates\n",


Are those internal methods something that should be expose properly from pyQuil?

🤷 This is the only place I've seen these used, so I don't know if we should move them over yet.

This is a great point. I'm thinking we should do a pyQuil v3 follow up for exposing some methods and processes publicly, where external dependencies use them. I've used some private methods in the Cirq integration.

Agree- a follow-up ticket after collecting all of the additional entry points sounds like the right approach.

CHANGELOG.md

docs/examples/graph-state.json

erichulburd

I think this is definitely a major version update. Otherwise, looks pretty ready to go.

docs/examples/graph-state.json

erichulburd · 2021-08-12T18:48:13Z

docs/examples/robust_phase_estimation.ipynb

-    "from pyquil.device import gates_in_isa\n",
-    "from pyquil.noise import decoherence_noise_with_asymmetric_ro, _decoherence_noise_model\n",
-    "# noise_model = decoherence_noise_with_asymmetric_ro(gates=gates_in_isa(qc.device.get_isa()), p00=0.92, p11=.87)\n",
+    "from pyquil.noise import decoherence_noise_with_asymmetric_ro, _decoherence_noise_model, _get_qvm_noise_supported_gates\n",


This is a great point. I'm thinking we should do a pyQuil v3 follow up for exposing some methods and processes publicly, where external dependencies use them. I've used some private methods in the Cirq integration.

erichulburd · 2021-08-12T18:49:03Z

forest/benchmarking/__init__.py

@@ -1 +1 @@
-__version__ = "0.7.1"
+__version__ = "0.8.0"


I think this should be a major version update.

It is, in the sense that this is still in beta 👍

Yep, 0.8.0 seems right to me.

ameyer-rigetti · 2021-08-12T19:00:03Z

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Tests


Let's replace Semaphore with GitHub Actions

requirements.txt

setup.py

ameyer-rigetti · 2021-08-12T22:44:11Z

@mhodson-rigetti I'm not sure why, but this test falls slightly out of tolerance in CI, but not locally: https://github.com/rigetti/forest-benchmarking/pull/215/checks?check_run_id=3316861010#step:4:567

Any opposition to widening the assertion's atol a bit? Alternately, I could mark the test as xfail and create an issue for it. I'd hate for this to block this PR

mhodson-rigetti · 2021-08-13T00:11:15Z

docs/examples/robust_phase_estimation.ipynb

@@ -705,4 +705,4 @@
 },
 "nbformat": 4,
 "nbformat_minor": 2
-}
+}


No newline at EOF- would normally be a flake8 violation (is flake8 used in this repo?).

Does flake8 check notebooks by default? Thought you needed some special addon for that.

mhodson-rigetti

Source reviewed. Don't see anything out of place.

mhodson-rigetti · 2021-08-13T00:53:40Z

@ameyer-rigetti regarding the failing test, I checked locally and both the 1Q and 2Q tests there are non-deterministic. Despite setting the seed on the QAM, the results change with every run, and I can induce failures on both tests just by running them enough times. First question is- is the seed broken? If you go back to master, is the result consistent? In which case, pyquil v3 has a defect in terms of seeding the QVM runs. If the last release has the same issue, the only options are (a) re-run the CI until it goes green, and note the issue; with (b) mitigate the error by (i) widening to 3*decay_error in both tests and also potentially increasing the 2Q num_shots=50 and num_sequences_per_depth=30 as per the 1Q case (for a better fit).

erichulburd · 2021-08-16T19:29:00Z

@mhodson-rigetti I was able to replicate non-determinism on master. Here is an example failure:

>       np.testing.assert_allclose(expected_decay, observed_decay, atol=2.5 * decay_error)
E       AssertionError: 
E       Not equal to tolerance rtol=1e-07, atol=0.0553496
E       
E       Mismatched elements: 1 / 1 (100%)
E       Max absolute difference: 0.05631447
E       Max relative difference: 0.06576378
E        x: array(0.8)
E        y: array(0.856314)

A look at this test and it seems that there is some randomness generated outside the QVM, specifically in generate_rb_experiment_sequences. Passing random_seed=1 I got 20/20 green locally running:

for run in {1..20}; do pytest forest/benchmarking/tests/test_randomized_benchmarking.py::test_2q_general_pauli_noise; done

Let me know if you think we should also increase atol in the tests assertion.

Change is here: #217

mhodson-rigetti · 2021-08-17T00:01:14Z

@erichulburd don't think you need to modify atol, but recommend extending fixing the seed to the 1Q test case which has the same underlying issue (and I could make it fail by running enough times). See the sub-issue.

kalzoo · 2022-02-05T02:12:08Z

Finally merging this! Just had to be unhooked from Semaphore. Thank you to @mhodson-rigetti , @erichulburd , @dbanty and of course Andrew Meyer! 🥂

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch from 9bf9085 to 25bb646 Compare August 9, 2021 22:49

ameyer-rigetti marked this pull request as ready for review August 9, 2021 22:52

ameyer-rigetti requested a review from a team as a code owner August 9, 2021 22:52

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch from 25bb646 to 2d42cb8 Compare August 9, 2021 22:53

ameyer-rigetti commented Aug 9, 2021

View reviewed changes

docs/examples/qubit_spectroscopy_cz_ramsey.ipynb Show resolved Hide resolved

ameyer-rigetti commented Aug 9, 2021

View reviewed changes

forest/benchmarking/quantum_volume.py Show resolved Hide resolved

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch 2 times, most recently from c946c5a to 7aaa3f5 Compare August 9, 2021 23:02

ameyer-rigetti requested review from dbanty, erichulburd, kalzoo, mhodson-rigetti and notmgsk August 9, 2021 23:16

dbanty approved these changes Aug 10, 2021

View reviewed changes

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch 2 times, most recently from 96d14bf to e7ca5bc Compare August 11, 2021 17:27

ameyer-rigetti commented Aug 11, 2021

View reviewed changes

docs/examples/graph-state.json Outdated Show resolved Hide resolved

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch 2 times, most recently from 0c4f7f6 to ec01d05 Compare August 11, 2021 22:48

erichulburd requested changes Aug 12, 2021

View reviewed changes

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch from ec01d05 to 677bcd2 Compare August 12, 2021 18:59

ameyer-rigetti commented Aug 12, 2021

View reviewed changes

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch 2 times, most recently from 8f160bb to 5b84388 Compare August 12, 2021 19:05

ameyer-rigetti requested a review from erichulburd August 12, 2021 19:23

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch from 5b84388 to e477fdc Compare August 12, 2021 20:53

ameyer-rigetti commented Aug 12, 2021

View reviewed changes

requirements.txt Outdated Show resolved Hide resolved

ameyer-rigetti commented Aug 12, 2021

View reviewed changes

setup.py Show resolved Hide resolved

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch 4 times, most recently from 14ff4da to 1886937 Compare August 12, 2021 21:49

Update for pyQuil v3

fe034cd

ameyer-rigetti force-pushed the upgrade-pyquil-v3 branch from 1886937 to fe034cd Compare August 12, 2021 22:05

mhodson-rigetti reviewed Aug 13, 2021

View reviewed changes

set random seed for rb experiment sequences

e944dff

erichulburd approved these changes Aug 19, 2021

View reviewed changes

erichulburd and others added 2 commits August 19, 2021 10:56

use pep 440 tilde for major pyquil version pin

c2bbe27

Docs: update Changelog

dc9deb2

kalzoo merged commit 4c2c3bf into master Feb 5, 2022

kalzoo deleted the upgrade-pyquil-v3 branch February 5, 2022 02:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update for pyQuil v3 #215

Update for pyQuil v3 #215

ameyer-rigetti commented Aug 9, 2021 •

edited

Loading

ameyer-rigetti commented Aug 9, 2021 •

edited

Loading

genos commented Aug 9, 2021

ameyer-rigetti commented Aug 9, 2021 •

edited

Loading

dbanty left a comment

dbanty Aug 10, 2021

ameyer-rigetti Aug 10, 2021

erichulburd Aug 12, 2021

mhodson-rigetti Aug 13, 2021

erichulburd left a comment

erichulburd Aug 12, 2021

erichulburd Aug 12, 2021

ameyer-rigetti Aug 12, 2021

mhodson-rigetti Aug 13, 2021

ameyer-rigetti Aug 12, 2021

ameyer-rigetti commented Aug 12, 2021 •

edited

Loading

mhodson-rigetti Aug 13, 2021

dbanty Aug 13, 2021

mhodson-rigetti left a comment

mhodson-rigetti commented Aug 13, 2021

erichulburd commented Aug 16, 2021 •

edited

Loading

mhodson-rigetti commented Aug 17, 2021

kalzoo commented Feb 5, 2022

		@@ -1 +1 @@
		__version__ = "0.7.1"
		__version__ = "0.8.0"

Update for pyQuil v3 #215

Update for pyQuil v3 #215

Conversation

ameyer-rigetti commented Aug 9, 2021 • edited Loading

Description

Checklist

ameyer-rigetti commented Aug 9, 2021 • edited Loading

genos commented Aug 9, 2021

ameyer-rigetti commented Aug 9, 2021 • edited Loading

dbanty 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

erichulburd 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

ameyer-rigetti commented Aug 12, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhodson-rigetti left a comment

Choose a reason for hiding this comment

mhodson-rigetti commented Aug 13, 2021

erichulburd commented Aug 16, 2021 • edited Loading

mhodson-rigetti commented Aug 17, 2021

kalzoo commented Feb 5, 2022

ameyer-rigetti commented Aug 9, 2021 •

edited

Loading

ameyer-rigetti commented Aug 9, 2021 •

edited

Loading

ameyer-rigetti commented Aug 9, 2021 •

edited

Loading

ameyer-rigetti commented Aug 12, 2021 •

edited

Loading

erichulburd commented Aug 16, 2021 •

edited

Loading