QGYM – A Gym for Training and Benchmarking RL-Based Quantum Compilation
qgym is a software framework that provides environments for training and benchmarking RL-based quantum compilers.
It is built on top of OpenAI Gym and abstracts parts of the compilation process that are irrelevant to AI researchers.
qgym includes three environments: InitialMapping, Routing, and Scheduling, each of which is customizable and extensible.
Documentation
We have created an extensive documentation with code snippets. Please feel free to contact us via s.feld@tudelft.nl if you have any questions, or by creating a GitHub issue.
Getting Started
What follows are some simple steps to get you running. You could also have a look at some Jupyter Notebooks that we have created for a tutorial at the IEEE International Conference on Quantum Computing and Engineering (QCE’22).
We also gave an talk about the package at qhack 2024, which you can find by clicking the image below.
Installing with pip
To install the qgym use
pip install qgym
If you would also like to use the notebooks, additional packages are required, which can simply be installed by using In this case, use
pip install qgym[tutorial]
Currently qgym has support for Python 3.8, 3.9, 3.10, 3.11 and 3.12.
Publication
The paper on qgym has been presented in the 1st International Workshop on Quantum Machine Learning: From Foundations to Applications (QML@QCE'23).
The publication can be found on computer.org
You can find the preprint of the paper on arxiv.
@inproceedings{van2023qgym,
title={qgym: A Gym for training and benchmarking RL-based quantum compilation},
author={Van Der Linde, Stan and De Kok, Willem and Bontekoe, Tariq and Feld, Sebastian},
booktitle={2023 IEEE International Conference on Quantum Computing and Engineering (QCE)},
volume={2},
pages={26--30},
year={2023},
organization={IEEE}
}
Team
Building qgym is a joint effort.
Core developers
Contributors and Power Users
Metadata
Release files for qgym 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| qgym-0.3.1.tar.gz | 64.3 kB | Without provenance | Details for qgym-0.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| qgym-0.3.1-py3-none-any.whl | Python 3 | none | any | Details for qgym-0.3.1-py3-none-any.whl |
Total release size: 147.0 kB
Release files / qgym-0.3.1.tar.gz
| Download URL | qgym-0.3.1.tar.gz |
|---|---|
| Size | 64.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e479efbd6b65360125353688fee31e16404857215990dae43acea103e14c83b0
|
|
BLAKE2b-256 checksum How to use checksums |
584922ab7f2cd665f7e723a7ec3ab723ebaf975fda6c0d4580e46fa524109ca7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.0
|
Release files / qgym-0.3.1-py3-none-any.whl
| Download URL | qgym-0.3.1-py3-none-any.whl |
|---|---|
| Size | 82.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
35d59719fe159ffd2b7505792c99256798042be5b115cb24f51995098e851695
|
|
BLAKE2b-256 checksum How to use checksums |
c858ad7b7683810878b89521fe8a01ca81f01f73c19db5444871123297c9f291
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.0
|
Security for qgym 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.