Metadata-Version: 2.3
Name: qml-essentials
Version: 0.1.21
Summary: 
License: MIT
Keywords: quantum,quantum machine learning,qml
Author: Melvin Strobl
Author-email: melvin.strobl@kit.edu
Maintainer: Melvin Strobl
Maintainer-email: melvin.strobl@kit.edu
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: pennylane (>=0.40.0,<0.41.0)
Project-URL: Documentation, https://cirkiters.github.io/qml-essentials/
Project-URL: Homepage, https://cirkiters.github.io/qml-essentials/
Project-URL: Repository, https://github.com/cirKITers/qml-essentials
Description-Content-Type: text/markdown

# QML Essentials

<p align="center">
<img src="docs/logo.svg" width="200" title="Logo">
</p>
<h3 align="center">A toolbox to make working with QML models easier.</h3>
<br/>

[![Quality](https://github.com/cirKITers/qml-essentials/actions/workflows/quality.yml/badge.svg)](https://github.com/cirKITers/qml-essentials/actions/workflows/quality.yml) [![Testing](https://github.com/cirKITers/qml-essentials/actions/workflows/test.yml/badge.svg)](https://github.com/cirKITers/qml-essentials/actions/workflows/test.yml) [![Documentation](https://github.com/cirKITers/qml-essentials/actions/workflows/docs.yml/badge.svg)](https://github.com/cirKITers/qml-essentials/actions/workflows/docs.yml)

## 📜 About

This repo contains some of the commonly used Ansaetze and coding stuff required for working with QML and Data-Reuploading models.
There are also dedicated classes to calculate entanglement and expressiblity of a provided model as well as its Fourier coefficients.

## 🚀 Getting Started

```
pip install qml-essentials
```
or
```
poetry add qml-essentials
```

To install our package from [PyPI](https://pypi.org/project/qml-essentials/).
You can find details on how to use it and further documentation on the corresponding [Github Page](https://cirkiters.github.io/qml-essentials/).

## 🚧 Contributing

Contributions are highly welcome! Take a look at our [Contribution Guidelines](https://github.com/cirKITers/qml-essentials/blob/main/CONTRIBUTING.md).
