mqt.predictor

MQT Predictor - A Tool for Automatic Device Selection with Device-Specific Circuit Compilation for Quantum Computing

https://github.com/munich-quantum-toolkit/predictor

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    1 of 7 committers (14.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

quantum-circuit quantum-compiler reinforcement-learning supervised-machine-learning

Keywords from Contributors

mesh regionalization yolov5 dag energy-system exoplanet molecular-dynamics-simulation hydrology pipeline-testing datacleaner
Last synced: 6 months ago · JSON representation

Repository

MQT Predictor - A Tool for Automatic Device Selection with Device-Specific Circuit Compilation for Quantum Computing

Basic Info
  • Host: GitHub
  • Owner: munich-quantum-toolkit
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 80.5 MB
Statistics
  • Stars: 76
  • Watchers: 1
  • Forks: 20
  • Open Issues: 12
  • Releases: 13
Topics
quantum-circuit quantum-compiler reinforcement-learning supervised-machine-learning
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Citation Security Support

README.md

PyPI OS License: MIT CI CD Documentation codecov

MQT Logo

MQT Predictor - Automatic Device Selection with Device-Specific Circuit Compilation for Quantum Computing

MQT Predictor is a framework that allows one to automatically select a suitable quantum device for a particular application and provides an optimized compiler for the selected device. It is part of the Munich Quantum Toolkit (MQT).

Documentation

Key Features

MQT Predictor supports end-users in navigating the vast landscape of choices by allowing them to mix-and-match compiler passes from various tools to create optimized compilers that transcend the individual tools. Evaluations on more than 500 quantum circuits and seven devices have shown that—compared to Qiskit's and TKET's most optimized compilation flows—the MQT Predictor yields circuits with an expected fidelity that is on par with the best possible result that could be achieved by trying out all combinations of devices and compilers and even achieves a similar performance when considering the critical depth as an alternative figure of merit.

Therefore, MQT Predictor tackles this problem from two angles:

  1. It provides a method (based on Reinforcement Learning) that produces device-specific quantum circuit compilers by combining compilation passes from various compiler tools and learning optimized sequences of those passes with respect to a customizable figure of merit. This mix-and-match of compiler passes from various tools allows one to eliminate vendor locks and to create optimized compilers that transcend the individual tools.

  2. It provides a prediction method (based on Supervised Machine Learning) that, without performing any compilation, automatically predicts the most suitable device for a given application. This completely eliminates the manual and laborious task of determining a suitable target device and guides end-users through the vast landscape of choices without the need for quantum computing expertise.

If you have any questions, feel free to create a discussion or an issue on GitHub.

Contributors and Supporters

The Munich Quantum Toolkit (MQT) is developed by the Chair for Design Automation at the Technical University of Munich and supported by the Munich Quantum Software Company (MQSC). Among others, it is part of the Munich Quantum Software Stack (MQSS) ecosystem, which is being developed as part of the Munich Quantum Valley (MQV) initiative.

MQT Partner Logos

Thank you to all the contributors who have helped make MQT Predictor a reality!

Contributors to munich-quantum-toolkit/predictor

The MQT will remain free, open-source, and permissively licensed—now and in the future. We are firmly committed to keeping it open and actively maintained for the quantum computing community.

To support this endeavor, please consider:

  • Starring and sharing our repositories: https://github.com/munich-quantum-toolkit
  • Contributing code, documentation, tests, or examples via issues and pull requests
  • Citing the MQT in your publications (see Cite This)
  • Citing our research in your publications (see References)
  • Using the MQT in research and teaching, and sharing feedback and use cases
  • Sponsoring us on GitHub: https://github.com/sponsors/munich-quantum-toolkit

Sponsor the MQT

Getting Started

mqt.predictor is available via PyPI.

console (.venv) $ pip install mqt.predictor

The following code gives an example on the usage:

```python3 from mqt.predictor import qcompile from mqt.bench import get_benchmark, BenchmarkLevel

Get a benchmark circuit from MQT Bench

qcuncompiled = getbenchmark(benchmark="ghz", level=BenchmarkLevel.ALG, circuit_size=5)

Compile it using the MQT Predictor

qccompiled, compilationinformation, quantumdevice = qcompile( qc=qcuncompiled, figureofmerit="expected_fidelity", )

Print the selected device and the compilation information

print(quantumdevice, compilationinformation)

Draw the compiled circuit

print(qc_compiled.draw()) ```

[!NOTE] To execute the code, respective machine learning models must be trained before. Up until mqt.predictor v2.0.0, pre-trained models were provided. However, this is not feasible anymore due to the increasing number of devices and figures of merits. Instead, we now provide a detailed documentation on how to train and setup the MQT Predictor framework.

Detailed documentation and examples are available at ReadTheDocs.

System Requirements

MQT Predictor can be installed on all major operating systems with all supported Python versions. Building (and running) is continuously tested under Linux, macOS, and Windows using the latest available system versions for GitHub Actions.

Cite This

Please cite the work that best fits your use case.

MQT Predictor (the tool)

When citing the software itself or results produced with it, cite the MQT Predictor paper:

bibtex @article{quetschlich2025mqtpredictor, title = {{MQT Predictor: Automatic Device Selection with Device-Specific Circuit Compilation for Quantum Computing}}, author = {Quetschlich, Nils and Burgholzer, Lukas and Wille, Robert}, year = {2025}, journal = {ACM Transactions on Quantum Computing (TQC)}, doi = {10.1145/3673241}, eprint = {2310.06889}, eprinttype = {arxiv} }

The Munich Quantum Toolkit (the project)

When discussing the overall MQT project or its ecosystem, cite the MQT Handbook:

bibtex @inproceedings{mqt, title = {The {{MQT}} Handbook: {{A}} Summary of Design Automation Tools and Software for Quantum Computing}, shorttitle = {{The MQT Handbook}}, author = {Wille, Robert and Berent, Lucas and Forster, Tobias and Kunasaikaran, Jagatheesan and Mato, Kevin and Peham, Tom and Quetschlich, Nils and Rovara, Damian and Sander, Aaron and Schmid, Ludwig and Schoenberger, Daniel and Stade, Yannick and Burgholzer, Lukas}, year = 2024, booktitle = {IEEE International Conference on Quantum Software (QSW)}, doi = {10.1109/QSW62656.2024.00013}, eprint = {2405.17543}, eprinttype = {arxiv}, addendum = {A live version of this document is available at \url{https://mqt.readthedocs.io}} }


Acknowledgements

The Munich Quantum Toolkit has been supported by the European Research Council (ERC) under the European Union's Horizon 2020 research and innovation program (grant agreement No. 101001318), the Bavarian State Ministry for Science and Arts through the Distinguished Professorship Program, as well as the Munich Quantum Valley, which is supported by the Bavarian state government with funds from the Hightech Agenda Bayern Plus.

MQT Funding Footer

Owner

  • Name: The Munich Quantum Toolkit (MQT)
  • Login: munich-quantum-toolkit
  • Kind: organization
  • Email: lukas@munichquantum.software
  • Location: Germany

A collection of design automation tools and software for quantum computing

GitHub Events

Total
  • Create event: 26
  • Release event: 1
  • Issues event: 7
  • Watch event: 4
  • Delete event: 29
  • Issue comment event: 36
  • Push event: 134
  • Pull request review comment event: 63
  • Pull request review event: 70
  • Pull request event: 65
  • Fork event: 2
Last Year
  • Create event: 26
  • Release event: 1
  • Issues event: 7
  • Watch event: 4
  • Delete event: 29
  • Issue comment event: 36
  • Push event: 134
  • Pull request review comment event: 63
  • Pull request review event: 70
  • Pull request event: 65
  • Fork event: 2

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 622
  • Total Committers: 7
  • Avg Commits per committer: 88.857
  • Development Distribution Score (DDS): 0.342
Past Year
  • Commits: 116
  • Committers: 7
  • Avg Commits per committer: 16.571
  • Development Distribution Score (DDS): 0.491
Top Committers
Name Email Commits
Nils Quetschlich N****h@t****e 409
pre-commit-ci[bot] 6****] 76
renovate[bot] 2****] 59
Lukas Burgholzer l****r@j****t 43
dependabot[bot] 4****] 30
Patrick Hopf 8****r 4
Jan Drewniok j****h@g****m 1
Committer Domains (Top 20 + Academic)
jku.at: 1 tum.de: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 3
  • Total pull requests: 59
  • Average time to close issues: over 1 year
  • Average time to close pull requests: 12 days
  • Total issue authors: 2
  • Total pull request authors: 10
  • Average comments per issue: 0.33
  • Average comments per pull request: 0.95
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 42
Past Year
  • Issues: 1
  • Pull requests: 59
  • Average time to close issues: N/A
  • Average time to close pull requests: 12 days
  • Issue authors: 1
  • Pull request authors: 10
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.95
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 42
Top Authors
Issue Authors
  • nquetschlich (2)
  • denialhaag (1)
Pull Request Authors
  • renovate[bot] (34)
  • Shaobo-Zhou (4)
  • nquetschlich (3)
  • denialhaag (3)
  • flowerthrower (2)
  • pre-commit-ci[bot] (2)
  • q-inho (1)
  • burgholzer (1)
  • dependabot[bot] (1)
Top Labels
Issue Labels
enhancement (2) bug (1) dependencies (1) python (1) continuous integration (1) minor (1)
Pull Request Labels
dependencies (37) pre-commit (18) python (10) github-actions (8) documentation (3) continuous integration (3) enhancement (2) refactor (1) fix (1) packaging (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 165 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 13
  • Total maintainers: 2
pypi.org: mqt.predictor

MQT Predictor - A MQT Tool for Automatic Device Selection with Device-Specific Circuit Compilation for Quantum Computing

  • Versions: 13
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 165 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 11.9%
Stargazers count: 13.6%
Average: 16.0%
Forks count: 17.3%
Dependent repos count: 30.6%
Maintainers (2)
Last synced: 6 months ago

Dependencies

.github/workflows/codeql.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • github/codeql-action/analyze v3 composite
  • github/codeql-action/init v3 composite
.github/workflows/coverage.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • codecov/codecov-action v3 composite
.github/workflows/deploy.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/mypy.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/release-drafter.yml actions
  • release-drafter/release-drafter v5 composite
pyproject.toml pypi
  • importlib_metadata >=4.4; python_version < '3.10'
  • importlib_resources >=5.0; python_version < '3.10'
  • mqt.bench >=1.0.0,<1.1.0
  • sb3_contrib >=2.0.0
  • scikit-learn >=1.3.0, <1.3.3
  • tensorboard >=2.11.0
.github/workflows/pretrained_model.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite