No project description provided
Project description
Mitiq
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.
Installation
Mitiq can be installed from PyPi via
pip install mitiq
To build from source, see these installation instructions. To test installation, run
import mitiq
mitiq.about()
This prints out version information about core requirements and optional quantum software packages which Mitiq can interface with.
If you would like to contribute to Mitiq, check out the contribution guidelines for more information.
Supported quantum programming libraries
Mitiq can currently interface with:
Cirq is a core requirement of Mitiq and is automatically installed. To use Mitiq with other quantum programming libraries, install the optional package(s) following the instructions linked above.
Supported quantum processors
Mitiq can be used on any quantum processor which can be accessed by supported quantum programming libraries and is available to the user.
Getting started
See the getting started guide in Mitiq's documentation for a complete walkthrough of how to use Mitiq. For a quick preview, check out the following snippet:
import numpy as np
from cirq import depolarize, Circuit, DensityMatrixSimulator, LineQubit, X
from mitiq.zne import execute_with_zne
def noisy_simulation(circ: Circuit) -> float:
"""Simulates a circuit with depolarizing noise.
Args:
circ: The quantum program as a Cirq Circuit.
Returns:
The expectation value of the |0><0| observable.
"""
circuit = circ.with_noise(depolarize(p=0.001))
rho = DensityMatrixSimulator().simulate(circuit).final_density_matrix
return np.real(np.trace(rho @ np.diag([1, 0])))
# simple circuit that should compose to the identity when noiseless
circ = Circuit(X(LineQubit(0)) for _ in range(80))
# run the circuit using a density matrix simulator with depolarizing noise
unmitigated = noisy_simulation(circ)
print(f"Error in simulation (w/o mitigation): {1.0 - unmitigated:.{3}}")
# run again, but using mitiq's zero-noise extrapolation to mitigate errors
mitigated = execute_with_zne(circ, noisy_simulation)
print(f"Error in simulation (with mitigation): {1.0 - mitigated:.{3}}")
Sample output:
Error in simulation (w/o mitigation): 0.0506
Error in simulation (with mitigation): 0.000519
Example with Qiskit
Example with Cirq
Error mitigation techniques
Mitiq currently implements:
- Zero-Noise Extrapolation,
- Probabilistic Error Cancellation,
- (Variable noise) Clifford data regression,
and is designed to support additional techniques.
Documentation
Mitiq's documentation is hosted at mitiq.readthedocs.io.
Developer information
We welcome contributions to Mitiq including bug fixes, feature requests, etc. Please see the contribution guidelines for more details. To contribute to the documentation, please see these documentation guidelines.
Authors
An up-to-date list of authors can be found here.
Research
We look forward to adding new features to Mitiq. If you have a proposal for implementing a new quantum error mitigation technique, or adding an example used in your research, please read our guidelines for contributing.
Citing Mitiq
If you use Mitiq in your research, please reference the Mitiq preprint as follows:
@misc{larose2020mitiq,
title={Mitiq: A software package for error mitigation on noisy quantum computers},
author={Ryan LaRose and Andrea Mari and Peter J. Karalekas
and Nathan Shammah and William J. Zeng},
year={2020},
eprint={2009.04417},
archivePrefix={arXiv},
primaryClass={quant-ph}
}
A list of papers citing Mitiq can be found here.
License
unitaryHACK
Mitiq is participating in unitaryHACK, check
out and contribute on open issues labeled
unitaryhack!
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.9.3.tar.gz.
File metadata
- Download URL: mitiq-0.9.3.tar.gz
- Upload date:
- Size: 80.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.2.post20210110 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3e78d58bea1841b94b1fa7d07c0d175ad2df78d022be4cf4494b705cd9e942cc |
|
| MD5 | 6b7cabfb12e5fdf3befbdaa92afdb2c8 |
|
| BLAKE2b-256 | e9349126c901f4d512cc6a0c8516aeb1292c17f789883ae0776b20bd9221f1d9 |
File details
Details for the file mitiq-0.9.3-py3-none-any.whl.
File metadata
- Download URL: mitiq-0.9.3-py3-none-any.whl
- Upload date:
- Size: 112.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.2.post20210110 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.7.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c615068547485a249e414b3a1d3c6cd46ff5f51007cf741355544d0812476006 |
|
| MD5 | ad82ab0859a3ba07cfa4aaffc7310259 |
|
| BLAKE2b-256 | 09131c442c375c7474c3eeaa5151c14c3c31c3c8521b1b0a686af20be1573cef |
