Mitiq

Summary

This release includes contributions from UnitaryHACK 2022! 🎉
We had 3 merged pull requests, and a fourth is looking to be merged in the next milestone.
Along with the great contributions from hackers, this release focused on expanding our ZNE examples to other frontends (Cirq, Braket, and Pennylane), building out learning-based PEC, and improving our benchmarking infrastructure.

All Changes

- Support the latest Cirq version (0.15.0) (andreamari, gh-1379)
- add ZNE example using pennylane (natestemen, gh-1384)
- Add ZNE example with Braket and IonQ (andreamari, gh-1363)
- docs: add natestemen as a contributor for infra, doc, test, code (allcontributors, gh-1383)
- remove comma (natestemen, gh-1381)
- add myself to authors (natestemen, gh-1372)
- Deploy asv benchmark data to web (natestemen, gh-1354)
- Batched mitigate (nylewong, gh-1286)
- Update black requirement from ~=22.3 to ~=22.6 (dependabot, gh-1370)
- Add Error Mitigation example with Cirq (Misty-W, gh-1351)
- Update amazon-braket-sdk requirement from ~=1.25.1 to ~=1.25.2 (dependabot, gh-1367)
- Update pennylane-qiskit requirement from ~=0.23.0 to ~=0.24.0 (dependabot, gh-1361)
- Update Mitiq paper code blocks based on paper review (andreamari, gh-1357)
- Update pennylane requirement from ~=0.23.1 to ~=0.24.0 (dependabot, gh-1362)
- Update amazon-braket-sdk requirement from ~=1.25.0 to ~=1.25.1 (dependabot, gh-1359)
- Improving the H2 example (obliviateandsurrender, gh-1337)
- Test on windows and mac on each PR and add openfermion to dev requirements (andreamari, gh-1348)
- Loss function for learning biased noise (Misty-W, gh-1340)
- Modify docstrings, documentation to use citations from refs.bib [unitaryhack] (wingcode, gh-1325)
- [unitaryhack] v2 Updated molecular hydrogen tutorial OpenFermion (lockwo, gh-1349)
- Update amazon-braket-sdk requirement from ~=1.24.0 to ~=1.25.0 (dependabot, gh-1345)
- Bump actions/setup-python from 3 to 4 (dependabot, gh-1344)
- [unitaryhack] Add thumbnails for examples (obliviateandsurrender, gh-1338)
- Revert "[unitaryhack] Updated molecular hydrogen tutorial" (andreamari, gh-1347)
- [unitaryhack] Updated molecular hydrogen tutorial (lockwo, gh-1296)
- Update mypy requirement from ~=0.960 to ~=0.961 (dependabot, gh-1342)
- Merge pull request 1320 from unitaryfund/nts-contrib-docs (natestemen)

Summary

This release officially adds support for the digital dynamical decoupling (DDD) technique which is now [fully documented](https://mitiq.readthedocs.io/en/latest/guide/ddd.html) and so ready to be applied by Mitiq users. This is still very new technique and so, if you notice any bugs, please let us know by
opening [issues](https://github.com/unitaryfund/mitiq/issues) on GihHub.
A further notable addition is the function [generate_quantum_volume_circuit()](https://mitiq.readthedocs.io/en/latest/apidoc.html#mitiq.benchmarks.quantum_volume_circuits.generate_quantum_volume_circuit) by nickdgardner, extending the Mitiq benchmarking module with quantum volume
circuits.

Congratulations to the new member of the Mitiq team natestemen and special thanks to the external contributors Aaron-Robertson, nickdgardner, ZhaoyiLi-HekJukZaaiZyuJan and amirebrahimi!

All Changes

- Add section 2 (use case) on DDD to user guide (nathanshammah, gh-1304)
- Update DDD options documentation (third section) (andreamari, gh-1327)
- Add additional options subsection for DDD (third section) (Aaron-Robertson, gh-1326)
- Add theory subsection for DDD (fifth section) (andreamari, natestemen, gh-1311)
- Update amazon-braket-sdk requirement from ~=1.19.0 to ~=1.24.0 (dependabot gh-1324, gh-1310, gh-1306, gh-1303, gh-1297, gh-1278, gh-1271)
- Ensure lists in documentation are displayed properly (natestemen, gh-1322)
- Add quantum volume circuits to benchmarking module (nickdgardner, gh-1281)
- Update readme table with DDD (andreamari, gh-1318)
- Test PR for unitaryhack test bounty (nathanshammah, gh-1317)
- Fixes unexpected error from repeated rule (Aaron-Robertson, gh-1316)
- Update mypy requirement from ~=0.950 to ~=0.960 (dependabot, gh-1314)
- Use single URL when referring to google style (natestemen, gh-1309)
- Update close-stale.yml (andreamari, gh-1295)
- Update contributing docs (amirebrahimi, gh-1305)
- Add fourth section of DDD docs (andreamari, gh-1276)
- Fix citation file (natestemen, gh-1299)
- Write the first sub-section of the DDD guide: How do I use DDD? (Misty-W, gh-1277)
- Update qiskit requirement from ~=0.36.1 to ~=0.36.2 (dependabot, gh-1302)
- Rename test_randomized_benchmaking.py to test_randomized_benchmarking.py (nickdgardner, gh-1284)
- Fix broken links in docs (andreamari, gh-1282)
- Create file structure (andreamari, gh-1275)
- Update pennylane requirement from ~=0.23.0 to ~=0.23.1 (dependabot, gh-1274)
- Fixed typo in documentation formula (ZhaoyiLi-HekJukZaaiZyuJan, gh-1246)
- Update version to 0.16dev (nathanshammah, gh-1268)

Summary

This milestone focused on updating dependencies and making progress on two new features, dynamical decoupling and learning based PEC. For dynamical decoupling, high-level functions and rules were added. For learning-based PEC, a function calculating representations with a biased (combination of depolarizing and dephasing) noise model was added. Several high priority bugs and issues were also fixed.

Special thanks to new contributors RubidgeCarrie and nickdgardner for their contributions to this release!

All Changes

- Add digital dynamical decoupling high-level functions (andreamari, gh-1251)
- Fix qubit naming in OperationRepresentations for Qiskit circuits (Misty-W, gh-1238)
- Fix broken link in contributing guide (Misty-W, gh-1257)
- Insert sequences for dynamical decoupling (Aaron-Robertson, gh-1221)
- Short sequences in DDD API docs (andreamari, gh-1237)
- Update pennylane-qiskit requirement from ~=0.22.0 to ~=0.23.0 (dependabot, gh-1249)
- Update qiskit requirement from ~=0.36.0 to ~=0.36.1 (dependabot, gh-1242)
- Update pennylane requirement from ~=0.22.2 to ~=0.23.0 (dependabot, gh-1248)
- Move the gh pages deploy to a manually triggered action (crazy4pi314, gh-1243)
- Update AUTHORS (nickdgardner, gh-1239)
- fix typo (nickdgardner, gh-1240)
- Add DDD to Api-Doc, fixes 1209 (nathanshammah, gh-1226)
- Add rules for dynamical decoupling (Aaron-Robertson, gh-1202)
- Fix compilation to native gateset in Braket notebook (andreamari, gh-1225)
- Update amazon-braket-sdk requirement from ~=1.17.0 to ~=1.19.0 ( dependabot, 1235)
- Function to represent OperationRepresentations for biased noise (Misty-W, gh-1233)
- Bump codecov/codecov-action from 2.1.0 to 3.0.0 (dependabot, gh-1216)
- Bump actions/stale from 4 to 5 (dependabot, gh-1217)
- Update sphinxcontrib-bibtex requirement from ~=2.4.1 to ~=2.4.2 (dependabot, gh-1218)
- Update cirq requirement from ~=0.14.0 to ~=0.14.1 dependabot, gh-1219)
- Added citiation file for the repo (RubidgeCarrie, gh-1200)
- Add mitigate_executor and cdr_decorator to mitiq.cdr (Aaron-Robertson, gh-1204)
- Update qiskit requirement from ~=0.35.0 to ~=0.36.0 (dependabot, gh-1213)

Summary

This milestone focused on updating dependencies and making progress on two new features, dynamical decoupling and learning based error mitigation techniques. A number of high priority bugs and issues also were fixed.

All Changes

- Update pennylane requirement from ~=0.22.1 to ~=0.22.2 (dependabot, gh-1203)
- Update mypy requirement from ~=0.931 to ~=0.942 (dependabot, gh-1183)
- Update pennylane-qiskit requirement from ~=0.20.0 to ~=0.22.0 (dependabot, gh-1170)
- Update pennylane requirement from ~=0.21.0 to ~=0.22.1 (dependabot, gh-1172)
- Update qiskit requirement from ~=0.34.2 to ~=0.35.0 (dependabot, gh-1199)
- Update black requirement from ~=22.1 to ~=22.3 (dependabot andreamari crazy4pi314, gh-1191)
- Avoid creation of empty moments when using fold_global (andreamari, gh-1196)
- Merge pull request 1198 from unitaryfund/1140-raise-error-if-executo (Misty-W)
- Port changes from old branch - workaround (Misty-W)
- Merge pull request 1195 from unitaryfund/update-qiskit (Misty-W)
- Update docs/source/guide/pec-3-options.myst crazy4pi314 (Misty-W)
- Merge branch 'master' into update-qiskit (crazy4pi314)
- Update Cirq to 0.14 (andreamari, gh-1193)
- fix pec-3-options notebook problem (andreamari)
- Remove option to squash moments in global folding (purva-thakre andreamari, gh-1113)
- update qiskit and fix conversions (andreamari)
- Idle qubits in conversion (Aaron-Robertson, gh-1185)
- Add get_circuit_mask() for dynamical decoupling (Aaron-Robertson, gh-1178)
- Update pydata-sphinx-theme requirement from ~=0.8.0 to ~=0.8.1 (dependabot, gh-1188)
- Add get_slack_matrix_from_circuit_matrix() function for dynamical decoupling (andreamari Aaron-Robertson,gh-1178)
- Fix sphinx dependency problem (andreamari , gh-1181)
- Create file structure for digital dynamical decoupling (andreamari, gh-1175)
- adding pages publish step (crazy4pi314,gh-1135)
- cast gate exponents to float (andreamari,gh-1174)
- Update release.rst (andreamari,gh-1145)
- Bump actions/setup-python from 2 to 3 (dependabot, gh-1149)
- Bump actions/checkout from 2 to 3 (dependabot, gh-1151)
- Update amazon-braket-sdk requirement from ~=1.15.0 to ~=1.17.0 (dependabot, gh-1153)
- fixing install permissions, container user is root (crazy4pi314 , gh-1147)

Summary

Mitiq is now compatible with the latest version (0.13.1) of Cirq! This update was blocked for a long time because of some technical difficulties. So, many thanks to vtomole for finding a solution to this issue!
This should solve several dependency conflicts or warnings that you may have got when running `pip install mitiq` or `pip install -U mitiq`.

The HTML rendering of all PyQuil examples in our documentation is now fixed. Thanks astrojuanlu for useful suggestions about readthedocs!

We also thank Rahul-Mistri for adding GHZ circuits to our benchmarking module and for making Clifford circuits compatible with the Mitiq CDR technique (instead of raising an error as it happened before this release).

We discussed and approved the design documents (RFC) for two new error-mitigation techniques: _learning-based PEC_ and _digital dynamical decoupling_. You can find them at [this link](https://github.com/unitaryfund/mitiq/projects/7). Special thanks go to Misty-W and Aaron-Robertson!

All Changes

- Add pre-executed pyquil notebooks (andreamari, gh-1142)
- Fix optimal representation tests and unskip one of them (andreamari gh-1141)
- Update amazon-braket-sdk requirement from ~=1.11.1 to ~=1.15.0 (dependabot, gh-1137, gh-1116, gh-1108, gh-1105)
- Update black requirement from ~=19.10b0 to ~=22.1 (dependabot, crazy4pi314, gh-1110)
- Bump actions/github-script from 5 to 6 (dependabot, gh-1129)
- Update mypy requirement from ~=0.930 to ~=0.931 (dependabot, gh-1078)
- docs: add vtomole as a contributor for test, code (allcontributors, andreamari, gh-1132)
- docs: add Rahul-Mistri as a contributor for test, code (allcontributors, andreamari, gh-1130)
- docs: add L-P-B as a contributor for test, code (allcontributors, gh-1131)
- Update PR template (nathanshammah, gh-1117)
- Remove unused functions from `cirq_utils` and fix non-deterministic tests. (andreamari gh-1123)
- Update pennylane requirement from ~=0.20.0 to ~=0.21.0 (dependabot, gh-1122)
- Bump cirq version from 0.10.0 to 0.13.0 (vtomole, gh-988)
- Can use Clifford Circuits with `execute_with_cdr` (Rahul-Mistri, gh-1104)
- Docstring for GHZ-circuits reformatted (Rahul-Mistri, gh-1101)

Summary

This release contains a considerable overhaul of the documentation organization and content:

- The guide is now divided into Core concepts and a new presentation of the quantum errror mitigation techniques (ZNE, PEC and CDR). Each technique contains subsections that explain with code snippets how to use them in Mitiq (gh-1021, gh-1004 gh-1031, gh-1099). Also the API doc has been extended and improved. Many thanks to purvathakre Misty-W for their help on rewriting the documentation and reviewing the pull requests.
- An example on how to use ZNE to improve the calculations of the energy potential landscape of molecular Hydrogen using VQE was added by andreamari.

**New features**

- GHZ circuits were added to the benchmark subpackage by Rahul-Mistri.
- Airspeed-velocity (asv) has been added to the CI by rmlarose.

All Changes

- Add core concepts guide page (crazy4pi314, nathanshammah, andreamari, gh-1053)
- Add cdr-2-use-case.myst (gh-1099) (andreamari, nathanshammah)
- CDR documentation reorg (nathanshammah, andreamari, crazy4pi314, gh-1031)
- Add molecular Hydrogen example (andreamari, gh-1087)
- Update pydata-sphinx-theme requirement from ~=0.7.2 to ~=0.8.0 (dependabot, gh-1091)
- Use raw.execute in asv benchmarks and remove GHZ circuits from asv (rmlarose)
- Added GHZ circuits to benchmark (Rahul-Mistri, gh-1089)
- Update scipy requirement from ~=1.7.2 to ~=1.7.3 (dependabot
, gh-1084)
- PR to trigger CI and fix a broken link (andreamari, gh-1082)
- Fix readthedocs by changing a LaTex equation (andreamari, nathanshammah, gh-1077)
- Add asv benchmarking framework (rmlarose, gh-1047)
- Update zne-3-options.myst (andreamari, gh-1075)
- Update API doc with REM, executors and observables (nathanshammah, gh-1050)
- ZNE Guide Reorg (crazy4pi314, Misty-W, purva-thakre, nathanshammah, andreamari, gh-1021)
- Fix broken link on master. (andreamari, gh-1069)
- Update mypy requirement from ~=0.910 to ~=0.930 (dependabot, gh-1065)
- Docs: add AkashNarayanan as a contributor for infra (allcontributors, gh-1059)
- Fixes 1034 release docs update (crazy4pi314, nathanshammah, gh-1054)
- Docs: add DSamuel1 as a contributor for code (allcontributors, Misty-W, gh-1056)
- Docs: add Misty-W as a contributor for code, example (allcontributors, gh-1055)
- Docs: update README.md (allcontributors)
- Update PEC docs (andreamari, nathanshammah, rmlarose, gh-1004)
- Revert "Update mypy requirement from ~=0.910 to ~=0.920 (nathanshammah, gh-1052)
- Update mypy requirement from ~=0.910 to ~=0.920 (dependabot, gh-1051)
- Update pytest-xdist[psutil] requirement from ~=2.4.0 to ~=2.5.0 (dependabot, gh-1044)
- Update amazon-braket-sdk requirement from ~=1.11.0 to ~=1.11.1 (dependabot, gh-1042)
- Update pennylane requirement from ~=0.19.0 to ~=0.19.1 (dependabot, gh-1029)
- Update amazon-braket-sdk requirement from ~=1.9.5 to ~=1.11.0 (dependabot, gh-1038)