| Name | squlearn JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | A library for quantum machine learning following the scikit-learnstandard. |
| upload_time | 2024-10-27 17:13:44 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9 |
| license | None |
| keywords |
quantum
machine learning
qml
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img alt="sQUlearn" src="https://raw.githubusercontent.com/sQUlearn/squlearn/main/docs/_static/logo.png" />
</p>
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 and QNNs. 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 Qiskit or PennyLane frameworks.
<p align="center">
<img width=500px alt="sQUlearn schematic" src="https://raw.githubusercontent.com/sQUlearn/squlearn/main/docs/_static/schematic.png" />
</p>
---
## Prerequisites
The package requires **at least Python 3.9**.
## Install sQUlearn
### Stable Release
To install the stable release version of sQUlearn, run the following command:
```bash
pip install squlearn
```
Alternatively, you can install sQUlearn directly from GitHub via
```bash
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
```bash
pip install .[examples]
```
## Contribute to sQUlearn
Thanks for considering contributing to sQUlearn! Please read our [contribution guidelines](https://github.com/sQUlearn/squlearn/blob/main/.github/CONTRIBUTING.md) before you submit a pull request.
---
## License
sQUlearn is released under the [Apache License 2.0](https://github.com/sQUlearn/squlearn/blob/main/LICENSE.txt)
## 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. (2023). sQUlearn - A Python Library for Quantum Machine Learning. [https://doi.org/10.48550/arXiv.2311.08990](https://doi.org/10.48550/arXiv.2311.08990)
## 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](http://www.ipa.fraunhofer.de/quantum)
For general questions regarding sQUlearn, use the [GitHub Discussions](https://github.com/sQUlearn/squlearn/discussions) or feel free to contact [sQUlearn@gmail.com](mailto: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).
---
Raw data
{
"_id": null,
"home_page": null,
"name": "squlearn",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": "David Kreplin <david.kreplin@ipa.fraunhofer.de>, Moritz Willmann <moritz.willmann@ipa.fraunhofer.de>",
"keywords": "quantum, machine learning, qml",
"author": null,
"author_email": "David Kreplin <david.kreplin@ipa.fraunhofer.de>, Moritz Willmann <moritz.willmann@ipa.fraunhofer.de>, Jan Schnabel <jan.schnabel@ipa.fraunhofer.de>, Frederic Rapp <frederic.rapp@ipa.fraunhofer.de>, Manuel Hagel\u00fcken <manuel.hagelueken@ipa.fraunhofer.de>, Marco Roth <marco.roth@ipa.fraunhofer.de>",
"download_url": "https://files.pythonhosted.org/packages/61/85/5a8c4f8a4701997545b041a34736c099a7c9e70c6267ed089646643f3e10/squlearn-0.8.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img alt=\"sQUlearn\" src=\"https://raw.githubusercontent.com/sQUlearn/squlearn/main/docs/_static/logo.png\" />\n</p>\n\nsQUlearn 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.\n\nsQUlearn offers scikit-learn compatible high-level interfaces for various kernel methods and QNNs. 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 Qiskit or PennyLane frameworks.\n\n<p align=\"center\">\n <img width=500px alt=\"sQUlearn schematic\" src=\"https://raw.githubusercontent.com/sQUlearn/squlearn/main/docs/_static/schematic.png\" />\n</p>\n\n---\n\n## Prerequisites\n\nThe package requires **at least Python 3.9**.\n## Install sQUlearn\n\n### Stable Release\n\nTo install the stable release version of sQUlearn, run the following command:\n```bash\npip install squlearn\n```\n\nAlternatively, you can install sQUlearn directly from GitHub via\n```bash\npip install git+ssh://git@github.com:sQUlearn/squlearn.git\n```\n\n## Examples\nThere are several more elaborate examples available in the folder ``./examples`` which display the features of this package.\nTutorials for beginners can be found at ``./examples/tutorials``.\n\nTo install the required packages, run\n```bash\npip install .[examples]\n```\n\n## Contribute to sQUlearn\nThanks for considering contributing to sQUlearn! Please read our [contribution guidelines](https://github.com/sQUlearn/squlearn/blob/main/.github/CONTRIBUTING.md) before you submit a pull request.\n\n---\n## License\n\nsQUlearn is released under the [Apache License 2.0](https://github.com/sQUlearn/squlearn/blob/main/LICENSE.txt)\n\n## Cite sQUlearn\nIf you use sQUlearn in your work, please cite our paper:\n\n> Kreplin, D. A., Willmann, M., Schnabel, J., Rapp, F., Hagel\u00fcken, M., & Roth, M. (2023). sQUlearn - A Python Library for Quantum Machine Learning. [https://doi.org/10.48550/arXiv.2311.08990](https://doi.org/10.48550/arXiv.2311.08990)\n\n## Contact\nThis project is maintained by the quantum computing group at the Fraunhofer Institute for Manufacturing Engineering and Automation IPA.\n\n[http://www.ipa.fraunhofer.de/quantum](http://www.ipa.fraunhofer.de/quantum)\n\nFor general questions regarding sQUlearn, use the [GitHub Discussions](https://github.com/sQUlearn/squlearn/discussions) or feel free to contact [sQUlearn@gmail.com](mailto:sQUlearn@gmail.com).\n\n---\n## Acknowledgements\n\nThis 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).\n\n---\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A library for quantum machine learning following the scikit-learnstandard.",
"version": "0.8.0",
"project_urls": {
"Homepage": "https://github.com/sQUlearn/squlearn"
},
"split_keywords": [
"quantum",
" machine learning",
" qml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40b3c97ea623df479a0036a61d02b40511ebf2fdbde5d78475cc788c8c06383a",
"md5": "390f70680702b6ded508e4ef7cbb938e",
"sha256": "f255c97c02117688428b2af3468d40376299320dd52efab3e087076ce45f6ef9"
},
"downloads": -1,
"filename": "squlearn-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "390f70680702b6ded508e4ef7cbb938e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 259347,
"upload_time": "2024-10-27T17:13:42",
"upload_time_iso_8601": "2024-10-27T17:13:42.637770Z",
"url": "https://files.pythonhosted.org/packages/40/b3/c97ea623df479a0036a61d02b40511ebf2fdbde5d78475cc788c8c06383a/squlearn-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61855a8c4f8a4701997545b041a34736c099a7c9e70c6267ed089646643f3e10",
"md5": "4d7057bec0e302bcfea678eb0397398c",
"sha256": "4427b026a7020eae98f71f078887d791511bacd19b5424a6d3b7bc6ffd51e799"
},
"downloads": -1,
"filename": "squlearn-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "4d7057bec0e302bcfea678eb0397398c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 3999500,
"upload_time": "2024-10-27T17:13:44",
"upload_time_iso_8601": "2024-10-27T17:13:44.122096Z",
"url": "https://files.pythonhosted.org/packages/61/85/5a8c4f8a4701997545b041a34736c099a7c9e70c6267ed089646643f3e10/squlearn-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 17:13:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sQUlearn",
"github_project": "squlearn",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "squlearn"
}
