Metadata-Version: 2.4
Name: qml-essentials
Version: 0.1.38
Summary: A toolbox to make working with QML models easier.
Project-URL: Homepage, https://cirkiters.github.io/qml-essentials/
Project-URL: Repository, https://github.com/cirKITers/qml-essentials
Project-URL: Documentation, https://cirkiters.github.io/qml-essentials/
Author-email: Melvin Strobl <melvin.strobl@kit.edu>, Maja Franz <maja.franz@oth-regensburg.de>
Maintainer-email: Melvin Strobl <melvin.strobl@kit.edu>
License-Expression: MIT
License-File: LICENSE
Keywords: qml,quantum,quantum machine learning
Requires-Python: <3.13,>=3.10
Requires-Dist: dill<0.5,>=0.4.0
Requires-Dist: jax<=0.4.28
Requires-Dist: jaxlib<=0.4.28
Requires-Dist: optax<=0.2.5
Requires-Dist: pennylane<0.41.0,>=0.40.0
Description-Content-Type: text/markdown

# QML Essentials

<p align="center">
<img src="https://raw.githubusercontent.com/cirKITers/qml-essentials/refs/heads/main/docs/logo.svg" width="200" title="Logo">
</p>
<h3 align="center">A toolbox to make working with QML models easier.</h3>
<br/>

## 📜 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.
Checkout our [Arxiv Paper](https://arxiv.org/abs/2506.06695) to learn more.

## 🚀 Getting Started

```
pip install qml-essentials
```
or with the [uv package manager](https://github.com/astral-sh/uv):
```
uv add qml-essentials
```

to install our package from [PyPI](https://pypi.org/project/qml-essentials/).

<p align="center">
<img src="docs/figures/code.svg" width="640" title="Code Example">
</p>
<p align="center">
<img src="docs/figures/histogram.svg" width="640" title="Histogram Figure">
</p>

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).

See our [coverage report](coverage/index.html) if you would like to contribute with further tests.
