Skip to main content

A library for quantum machine learning following the scikit-learn standard.

Project description

sQUlearn

sQUlearn is a user-friendly, NISQ-ready Python library for quantum machine learning (QML), designed for seamless integration with classical machine learning tools like scikit-learn. The library's dual-layer architecture serves both QML researchers and practitioners, enabling efficient prototyping, experimentation, and pipelining. sQUlearn provides a comprehensive tool set that includes both quantum kernel methods and quantum neural networks, along with features like customizable data encoding strategies, automated execution handling, and specialized kernel regularization techniques. By focusing on NISQ-compatibility and end-to-end automation, sQUlearn aims to bridge the gap between current quantum computing capabilities and practical machine learning applications.

sQUlearn offers scikit-learn compatible high-level interfaces for various kernel methods, QNNs and quantum reservoir computing. They build on top of the low-level interfaces of the QNN engine and the quantum kernel engine. The executor is used to run experiments on simulated and real backends of the PennyLane, Qiskit and Qulacs frameworks.

sQUlearn schematic


Prerequisites

The package requires at least Python 3.10.

Install sQUlearn

Stable Release

To install the stable release version of sQUlearn, run the following command:

pip install squlearn

Alternatively, you can install sQUlearn directly from GitHub via

pip install git+ssh://git@github.com:sQUlearn/squlearn.git

Examples

There are several more elaborate examples available in the folder ./examples which display the features of this package. Tutorials for beginners can be found at ./examples/tutorials.

To install the required packages, run

pip install .[examples]

Contribute to sQUlearn

Thanks for considering contributing to sQUlearn! Please read our contribution guidelines before you submit a pull request.


License

sQUlearn is released under the Apache License 2.0

Cite sQUlearn

If you use sQUlearn in your work, please cite our paper:

Kreplin, D. A., Willmann, M., Schnabel, J., Rapp, F., Hagelüken, M., & Roth, M. (2025). sQUlearn: A Python Library for Quantum Machine Learning. IEEE Software, 42(5), 65–72. https://doi.org/10.1109/MS.2025.3527736

Contact

This project is maintained by the quantum computing group at the Fraunhofer Institute for Manufacturing Engineering and Automation IPA.

http://www.ipa.fraunhofer.de/quantum

For general questions regarding sQUlearn, use the GitHub Discussions or feel free to contact sQUlearn@gmail.com.


Acknowledgements

This project was supported by the German Federal Ministry of Economic Affairs and Climate Action through the projects AutoQML (grant no. 01MQ22002A) and AQUAS (grant no. 01MQ22003D), as well as the German Federal Ministry of Education and Research through the project H2Giga Degrad-EL3 (grant no. 03HY110D).

Disclaimer

This software is provided strictly for research and experimental purposes. It represents early-stage exploratory work and has not been validated, verified, or tested for any operational, commercial, or production use.

Technology Readiness Level: TRL 1–3 (Basic principles observed through proof-of-concept)

  • No claims are made regarding reliability, accuracy, or fitness for any particular purpose
  • The codebase may be incomplete, unstable, or subject to fundamental changes without notice
  • Results produced by this software are not guaranteed to be reproducible or correct
  • This project exists solely for academic inquiry, algorithmic exploration, and open scientific collaboration

This software is not designed, intended, or suitable for deployment in any real-world system or application. Users assume all responsibility for any use beyond basic research experimentation.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

squlearn-0.11.1.tar.gz (6.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

squlearn-0.11.1-py3-none-any.whl (314.9 kB view details)

Uploaded Python 3

File details

Details for the file squlearn-0.11.1.tar.gz.

File metadata

  • Download URL: squlearn-0.11.1.tar.gz
  • Upload date:
  • Size: 6.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for squlearn-0.11.1.tar.gz
Algorithm Hash digest
SHA256 8646489b7e3c44c38466d34a50dea9f26ed29bae8ddeb391990207a1d82c9895
MD5 299e61b5f402ded65dc0cc18772490e6
BLAKE2b-256 cf38cbffb4feb93b6befc5e8dd1cc1107eff417ffb943844d6440f7057e842ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for squlearn-0.11.1.tar.gz:

Publisher: publish.yml on sQUlearn/squlearn

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file squlearn-0.11.1-py3-none-any.whl.

File metadata

  • Download URL: squlearn-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 314.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for squlearn-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9567d3d007d498bbab50485fabed0568d4da19c416cf090125543dccba70fc60
MD5 8b5685342cb003f88a80966bbece1174
BLAKE2b-256 8189395c7a0d261362cda528099bf6a844e273da0441afb8ec360dbde17e51ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for squlearn-0.11.1-py3-none-any.whl:

Publisher: publish.yml on sQUlearn/squlearn

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page