Skip to content

Releases: unitaryfund/mitiq

v0.33.0

20 Dec 23:24
f58920f
Compare
Choose a tag to compare

Version 0.33.0

Minor update from 0.32.0 to fix a bug 🐛 in the mitiq.shadows module where an incorrect index was being used.

All changes

  • Changed to use the split for b_list_shadow (#2137) [@bdg221]

v0.32.0

19 Dec 19:11
3733bec
Compare
Choose a tag to compare

Version 0.32.0

Happy holidays, and happy (almost) new year!! ❄️☃️🎄🎊 This will be our last release of the year, and we'd like to thank everyone who has contributed to Mitiq over the past 12 months. We've accomplished so much in the way of error mitigation this year, and we couldn't have done it without the support and time given by the volunteers.
Thank you!

The calibrator logs have been revamped for to support result discovery and analysis. The Calibrator.run method now support two options: flat and cartesian to display the experiment results in either a linear fashion, or grid-like. Results here have been truncated for brevity.

>>> calibrator.run(log="flat")
┌──────────────────────────┬────────────────────────────────────┬────────────────────────────┐
│ benchmarkstrategyperformance                │
├──────────────────────────┼────────────────────────────────────┼────────────────────────────┤
│ Type: ghzTechnique: ZNE                     │ ✔                          │
│ Num qubits: 2Factory: LinearNoisy error: 0.04          │
│ Circuit depth: 2Scale factors: 1.0, 2.0, 3.0Mitigated error: 0.02      │
│ Two qubit gate count: 1Scale method: fold_gates_at_randomImprovement factor: 2.0    │
├──────────────────────────┼────────────────────────────────────┼────────────────────────────┤
│ Type: ghzTechnique: ZNE                     │ ✘                          │
│ Num qubits: 2Factory: LinearNoisy error: 0.04          │
│ Circuit depth: 2Scale factors: 1.0, 3.0, 5.0Mitigated error: 0.0658    │
│ Two qubit gate count: 1Scale method: fold_globalImprovement factor: 0.6076 │
├──────────────────────────┼────────────────────────────────────┼────────────────────────────┤
│ Type: ghzTechnique: ZNE                     │ ✘                          │
│ Num qubits: 2Factory: RichardsonNoisy error: 0.98          │
│ Circuit depth: 33Scale factors: 1.0, 3.0, 5.0Mitigated error: 1.03      │
│ Two qubit gate count: 14Scale method: fold_globalImprovement factor: 0.9515 │
└──────────────────────────┴────────────────────────────────────┴────────────────────────────┘
>>> calibrator.run(log="cartesian")
┌────────────────────────────────────┬────────────────────────────┬────────────────────────────┐
│ strategy\benchmarkType: ghzType: mirror               │
│                                    │ Num qubits: 2Num qubits: 2              │
│                                    │ Circuit depth: 2Circuit depth: 33          │
│                                    │ Two qubit gate count: 1Two qubit gate count: 14   │
├────────────────────────────────────┼────────────────────────────┼────────────────────────────┤
│ Technique: ZNE                     │ ✘                          │ ✘                          │
│ Factory: RichardsonNoisy error: 0.03Noisy error: 1.0           │
│ Scale factors: 1.0, 2.0, 3.0Mitigated error: 0.09Mitigated error: 1.03      │
│ Scale method: fold_globalImprovement factor: 0.3333Improvement factor: 0.9709 │
├────────────────────────────────────┼────────────────────────────┼────────────────────────────┤
│ Technique: ZNE                     │ ✘                          │ ✔                          │
│ Factory: RichardsonNoisy error: 0.03Noisy error: 1.0           │
│ Scale factors: 1.0, 3.0, 5.0Mitigated error: 0.0563Mitigated error: 0.97      │
│ Scale method: fold_globalImprovement factor: 0.5333Improvement factor: 1.0309 │
├────────────────────────────────────┼────────────────────────────┼────────────────────────────┤
│ Technique: ZNE                     │ ✘                          │ ✔                          │
│ Factory: LinearNoisy error: 0.03Noisy error: 1.0           │
│ Scale factors: 1.0, 3.0, 5.0Mitigated error: 0.0417Mitigated error: 0.9975    │
│ Scale method: fold_globalImprovement factor: 0.72Improvement factor: 1.0025 │
└────────────────────────────────────┴────────────────────────────┴────────────────────────────┘

New benchmarking circuits: mitiq.benchmarks now contains a function generate_random_clifford_t_circuit which does what it says on the tin. Special shoutout to new UF team member Farrokh Labib (@FarLab) for this contribution.

from mitiq.benchmarks import generate_random_clifford_t_circuit

clifft = generate_random_clifford_t_circuit(
    num_qubits=2,
    num_oneq_cliffords=5,
    num_twoq_cliffords=5,
    num_t_gates=5
)
print(clifft)
# 0: ───────────@───S───T───@───H───T───X───T───T───@───@───────
#               │           │           │           │   │
# 1: ───S───T───@───────────X───────────@───S───────@───X───S───

The Executor.run method now supports a single circuit instance in addition to a list for ease of use when working with a single circuit.

- executor.run([circuit])
+ executor.run(circuit)

Faster Tests! Working on Mitiq has never been easier to develop with a faster (by 36%) test suite.

📓 Documentation

This release contains quite a few documentation improvements, including

  1. New workflow images to elucidate the workflow for for using the mitiq.shadows module (available here)
  2. A reorganized API-doc which should be easier to navigate
  3. General clean up of the CDR user guide pages

Commits

📦 Dependency updates

🧑‍💻 Dev Dependency updates

Release v0.31.0

02 Nov 22:49
638e31b
Compare
Choose a tag to compare

Changelog

Version 0.31.0

Released November 2, 2023

Summary

This release contains several documentation improvements and some new additions. Quantum subspace expansion (QSE) is added to the user guide (thanks @bubakazouba). Thanks to our first time contributors @dubeyPraY for a new tutorial on using PennyLane and Mitiq in calculating the energy landscape of a simple variational circuit and @kozhukalov for adding the PEC noise level and calculated error to the calibration logs. We also removed support for python 3.8.

All changes

Dependency updates

New Contributors

Full Changelog: v0.30.0...v0.31.0

Release v0.30.0

13 Oct 17:10
68b2b12
Compare
Choose a tag to compare

Changelog

Version 0.30.0

Released October 13, 2023

Summary

This release contains several documentation improvements and some new additions.
The classical shadows documentation has been improved (including a tutorial!) by @Min-Li. The Pauli Twirling method is added to the user guide (thanks @Aaron-Robertson and @purva-thakre). There is a new tutorial applying both zero-noise extrapolation (ZNE) and Clifford Data Regression (CDR) to quantum simulation, for the 1D Ising chain, in Cirq, by @farzadkianvash, a new contributor! The documentation has been further improved and unified by @Misty-W and @natestemen.

In terms of additions, a new type of benchmark quantum circuits, "rotated" randomized benchmarking (RB) quantum circuits have been added by @Misty-W, for more general benchmarks.

All changes

Dependency updates

What's Changed

New Contributors

Full Changelog: v0.29.0...v0.30.0

v0.29.0

09 Sep 00:22
ee85edf
Compare
Choose a tag to compare

Version 0.29.0

Summary

Update Pauli Twirling

Thanks to @purva-thakre for updating Mitiq's PT functions, clarifying that PT is a noise tailoring technique and for consolidating utilities to be shared between PT and other techniques.
This release replaces the execute_with_pt function with pauli_twirl_circuit.

from mitiq.pt.pt import pauli_twirl_circuit

pauli_twirl_circuit(circuit)

Classical Shadows

Top-level functions and tests for classical shadows estimation are now available in Mitiq.
Congrats @Min-Li on completing the main functionality for this technique!
Note that documentation for classical shadows estimation is not yet available but coming soon.

from mitiq.shadows.shadows import shadow_quantum_processing, classical_post_processing

shadow_outcomes = shadow_quantum_processing(circuit, executor, num_total_measurements_shadow)
results = classical_post_processing(shadow_outcomes)

Stim + Mitiq tutorial

Added a tutorial demonstrating a method of combining quantum error mitigation (QEM) and quantum error correction (QEC), reducing the effective logical error rate of the computation.
This tutorial also introduces the use of Mitiq’s ZNE functions with a new backend, the Stim stabilizer simulator.

Calibration, Testing, and Documentation

Streamlined formatting of calibration logs, removed redundant test cases, and fixed documentation issues.
Thanks @natestemen for these improvements and for reviewing many of the PRs in this release!

Also, congrats to our new contributor @bdg221 for closing their first Mitiq PR! 🎉

All changes

Dependency updates

v0.28.0

02 Aug 01:20
703fe7f
Compare
Choose a tag to compare

Summary

Quantum Subspace Expansion

With the main functionaly implemented, quantum subspace expansion is now available in Mitiq! The technique requires a sequence of check operators, a Hamiltonian, and an observable in addition to the typical circuit and executor that Mitiq needs to operate.

from mitiq.qse import execute_with_qse

execute_with_qse(circuit, executor, check_operators, code_hamiltonian, observable)

This feature is still in flux, and would greatly benefit from further testing. Do give a try, and let us know if you have feedback! More details can be found in our API-doc. Congratulations to @bubakazouba for the great work here.

PEC Calibration

Last release we added support to run PEC experiments within the calibration module. This release we made two improvements:

  1. Calibration experiments now represent all two-qubit gates by default (previously this was just $\mathrm{C}X$ and $\mathrm{C}Z$ gates.)
  2. When running calibrator.run(log=True) you will now find results from your PEC pretty-printed alongside any ZNE experiments.

Installation

Our core dependencies (NumPy, Cirq, SciPy) are now less tightly specified which means easier installs for users!

Robust Shadow Estimation

@Min-Li has been hard at work bringing shadows to Mitiq. The shadows module is not quite ready for use, but you can get a sneak peak of what's to come in the Classical Shadows section of our API-doc.

All changes

Dependency updates

  • Update pennylane requirement from ~=0.30.0 to ~=0.31.0 (#1888) [@dependabot]
  • Update cirq requirement from ~=1.1.0 to ~=1.2.0 (#1922) [@dependabot]
  • Update qiskit requirement from ~=0.43.3 to ~=0.44.0 (#1935) [@dependabot]
  • Update amazon-braket-sdk requirement from ~=1.51.0 to ~=1.52.0 (#1933) [@dependabot]
  • Update qiskit-ibm-provider requirement from ~=0.6.1 to ~=0.6.2 (#1932) [@dependabot]
  • Update amazon-braket-sdk requirement from ~=1.50.0 to ~=1.51.0 (#1928) [@dependabot]
  • Update qiskit requirement from ~=0.43.2 to ~=0.43.3 (#1925) [@dependabot]
  • Update amazon-braket-sdk requirement from ~=1.49.1 to ~=1.50.0 (#1926) [@dependabot]
  • Update amazon-braket-sdk requirement from ~=1.49.0 to ~=1.49.1 (#1916) [@dependabot]
  • Update amazon-braket-sdk requirement from ~=1.46.0 to ~=1.49.0 (#1915) [@dependabot]

v0.27.0

06 Jul 12:09
8180b50
Compare
Choose a tag to compare

Changelog

Version 0.27.0

Summary

Highlights from this release include adding new benchmark quantum circuits: Mirror Quantum Volume Circuits (@purva-thakre) and adding PEC as technique supported by calibration (@Misty-W). After approval of the related RFC on quantum subspace expansion technique, the first utils have been added (@bubakazouba). Other improvements include a new tutorial on quantum many body scars (@DHuybrechts); issues solved during unitaryHACK such as improvement to the cost estimation for Calibrator (@YuNariai), Qiskit Upgrade and Deprecation Warnings (@andre-a-alves), and a new function to register user defined Mitiq converters (@Aaron-Robertson).

All changes

v0.26.0

10 May 23:28
58dfd2d
Compare
Choose a tag to compare

Summary

Highlights from this release include functions for applying Pauli Twirling of CNOT and CZ gates, support for noise scaling by circuit layer in ZNE, functions to generate Quantum Phase Estimation benchmarking circuits, and a new example composing two Mitiq techniques: REM and ZNE.
Special thanks to UF Ambassadors Purva Thakre and Aaron Robertson for their contributions to this release!

The use of the Pauli Twirling module is demonstrated in the following code cell*.

from mitiq import pt
twirled_value = pt.execute_with_pauli_twirling(circuit, expval_executor)

*Thorough testing and documentation of Pauli Twirling to follow in future releases.
If any bugs or inconsistencies are encountered, please open an issue.

All changes

v0.25.0

03 Apr 20:31
c849314
Compare
Choose a tag to compare

Summary

Highlights from this release include a bug fixed in DDD, extended documentation for identity insertion as a noise scaling technique, new results from testing DDD on IBMQ hardware, a new function mitiq.benchmarks.w_state_circuits.generate_w_circuit to generate W-state circuits, and a finalized calibration API. The new calibration module can be used as such:

from mitiq import Calibrator

cal = Calibrator(execute, frontend="cirq")
cal.execute_with_mitigation(circuit, expval_executor)

Breaking Changes: The force_run_all option for the evaluate method defined on Executor objects now defaults to True.

All changes

v0.24.0

02 Mar 22:02
6587982
Compare
Choose a tag to compare

Changelog

Version 0.24.0

Highlights of this release include refactoring of parts of the PEC module, improvements to the Calibration data and settings structures,
completion of the REM section of the user guide, and the publishing of a Mitiq tutorial first presented as a lab exercise at the SQMS/GGI 2022 Summer School on Quantum Simulation of Field Theories.
Special thanks to UF Ambassadors Amir Ebrahimi and Purva Thakre for their contributions to this release!

Breaking changes: The class NoisyOperation is deprecated and removed from Mitiq. Moreover the initialization arguments of the OperationRepresentation class changed. Please check the associated API-docs and the PEC section of the docs for more details.