Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.
Project description
Mitiq is a Python toolkit for implementing error mitigation techniques on quantum computers.
Current quantum computers are noisy due to interactions with the environment, imperfect gate applications, state preparation and measurement errors, etc. Error mitigation seeks to reduce these effects at the software level by compiling quantum programs in clever ways.
Want to know more? Check out our documentation and chat with us on Discord.
Do you use near-term quantum hardware? Have you tried Mitiq? Either way, take our survey and help make Mitiq better! bit.ly/mitiq-survey
Quickstart
Installation
pip install mitiq
Example
Define a function which inputs a circuit and returns an expectation value you want to compute, then use Mitiq to mitigate errors.
import cirq
from mitiq import zne, benchmarks
def execute(circuit: cirq.Circuit, noise_level: float = 0.001) -> float:
"""Returns Tr[ρ |0⟩⟨0|] where ρ is the state prepared by the circuit with depolarizing noise."""
noisy_circuit = circuit.with_noise(cirq.depolarize(p=noise_level))
return cirq.DensityMatrixSimulator().simulate(noisy_circuit).final_density_matrix[0, 0].real
circuit: cirq.Circuit = benchmarks.generate_rb_circuits(n_qubits=1, num_cliffords=50)[0]
true_value = execute(circuit, noise_level=0.0) # Ideal quantum computer.
noisy_value = execute(circuit) # Noisy quantum computer.
zne_value = zne.execute_with_zne(circuit, execute) # Noisy quantum computer + Mitiq.
print(f"Error (w/o Mitiq): %0.4f" %abs((true_value - noisy_value) / true_value))
print(f"Error (with Mitiq): %0.4f" %abs((true_value - zne_value) / true_value))
Sample output:
Error (w/o Mitiq): 0.0688
Error (with Mitiq): 0.0002
See our guides and examples for more explanation, techniques, and benchmarks. The examples and other notebooks can be run interactively on the cloud with mybinder.org.
Quick Tour
Error mitigation techniques
| Technique | Documentation | Mitiq module | Paper Reference(s) |
|---|---|---|---|
| Zero-noise extrapolation | ZNE | mitiq.zne | 1611.09301 1612.02058 1805.04492 |
| Probabilistic error cancellation | PEC | mitiq.pec | 1612.02058 1712.09271 1905.10135 |
| (Variable-noise) Clifford data regression | CDR | mitiq.cdr | 2005.10189 2011.01157 |
| Dynamical decoupling | DDD | mitiq.cdd | 9803057 1807.08768 |
See our roadmap for additional candidate techniques to implement. If there is a technique you are looking for, please file a feature request.
Interface
We refer to any programming language you can write quantum circuits in as a frontend, and any quantum computer / simulator you can simulate circuits in as a backend.
Supported frontends
| Cirq | Qiskit | pyQuil | Braket | PennyLane |
|---|---|---|---|---|
 |
 |
 |
 |
 |
Note: Cirq is a core requirement of Mitiq and is installed when you pip install mitiq.
Supported backends
You can use Mitiq with any backend you have access to that can interface with supported frontends.
Benchmarks
Mitiq uses asv to benchmark the core functionalities of the project.
They are found in the benchmarks/ directory and their changes can be seen overtime at https://benchmarks.mitiq.dev/.
Citing Mitiq
If you use Mitiq in your research, please reference the Mitiq whitepaper using the bibtex entry found in CITATION.bib.
A list of papers citing Mitiq can be found on Google Scholar / Semantic Scholar.
License
Contributing
We welcome contributions to Mitiq including bug fixes, feature requests, etc. To get started, check out our contribution guidelines and/or documentation guidelines. An up-to-date list of contributors can be found here and below.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file mitiq-0.21.0.tar.gz.
File metadata
- Download URL: mitiq-0.21.0.tar.gz
- Upload date:
- Size: 110.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fe0de26e1222530fe47fa347440d05c46dcdcfa172b2e836b19d319afee631e2 |
|
| MD5 | 546031f60c589724b7bb30f90076c11f |
|
| BLAKE2b-256 | 758e6645dcd39a8d79f4989fad222c70e2a130820bdec4fef68f72a662257f29 |
File details
Details for the file mitiq-0.21.0-py3-none-any.whl.
File metadata
- Download URL: mitiq-0.21.0-py3-none-any.whl
- Upload date:
- Size: 150.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7494d53248168e5eafe88f0633fd68f6cc0ec79b24416561dab1b7349c900fa0 |
|
| MD5 | 8a68682f6c1add134ac14c44d9dfbf1c |
|
| BLAKE2b-256 | 87873d00d8a705ec254d4022d5b7245905a9966687b2b0ebd5a617d4b187f884 |
