Qiskit Device Benchmarking is a respository for code to run various device level benchmarks through Qiskit. The repository endevours to accomplish several goals, including, but not limited to:
- Code examples for users to replicate reported benchmarking metrics through the Qiskit backend. These will likely be notebooks to run code in the Qiskit Experiments repo, but some of the code may reside here.
- More in-depth benchmarking code that was discussed in papers and has not been integrated into Qiskit Experiments.
- Fast circuit validation tests.
The repository is not intended to define a benchmark standard. This code base is not guaranteed to be stable and may have breaking changes.
At the top level we have notebooks that gives users examples on how to run various benchmarks.
- Notebooks: Jupyter notebooks for running benchmarks
Under a top level folder qiskit_device_benchmarking we have repository code files that can be imported from python:
- Utilities: Benchmarking utility/helper code not found elsewhere in qiskit. If these prove useful they will be pushed into standard qiskit or qiskit-experiments.
- Benchmarking Code: General folder for benchmarking code, which may include standalone code and extensions to qiskit-experiments for custom benchmarks.
- Verification: Fast verification via mirror circuits using a command line program.
For clarity here we provide links from various papers to the code in this repo. Not necessarily the exact code used in these manuscripts, but representative of what was run.
- Layer Fidelity: David C. McKay, Ian Hincks, Emily J. Pritchett, Malcolm Carroll, Luke C. G. Govia, Seth T. Merkel. Benchmarking Quantum Processor Performance at Scale (2023). Code
- Mirror QV: Mirko Amico, Helena Zhang, Petar Jurcevic, Lev S. Bishop, Paul Nation, Andrew Wack, David C. McKay. Defining Standard Strategies for Quantum Benchmarks (2023). Code
- Mid-circuit measurement RB: Luke C. G. Govia, Petar Jurcevic, Christopher J. Wood, Naoki Kanazawa, Seth T. Merkel, David C. McKay. A randomized benchmarking suite for mid-circuit measurements (2022). Code
- Dynamic circuits RB: Liran Shirizly, Luke C. G. Govia, David C. McKay. Randomized Benchmarking Protocol for Dynamic Circuits (2024). Code
git clone git@github.com:qiskit-community/qiskit-device-benchmarking.git
cd qiskit-device-benchmarking
pip install .
Please open a github issue or pull request if you would like to contribute.
Portions of the code in this repository was developed via sponsorship by the Army Research Office ``QCISS Program'' under Grant Number W911NF-21-1-0002.