qml-essentials 0.2.1

A toolbox to make working with QML models easier.

QML Essentials

A toolbox to make working with QML models easier.

📜 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 to learn more.

🚀 Getting Started

pip install qml-essentials

or with the uv package manager:

uv add qml-essentials

to install our package from PyPI.

You can find details on how to use it and further documentation on the corresponding Github Page.

📦 Package Structure

The following diagram provides an overview on how the different components within this package depend on each other.

flowchart LR
    qmless([QML Essentials])
    qmless --> qmless.ansaetze([Ansaetze])
    qmless.ansaetze --> qmless.blocks([Blocks])
    qmless.blocks --> qmless.gates([Gates])
    qmless.blocks --> qmless.topo([Topologies])
    qmless.gates --> qmless.unitary([UnitaryGates])
    qmless.gates --> qmless.pulse([PulseGates])
    qmless --> qmless.coefficients([Coefficients])
    qmless.coefficients --> qmless.analytical([Analytical])
    qmless.coefficients --> qmless.numerical([Numerical])
    qmless.numerical --> qmless.fcc([Fourier Coefficient Correlation])
    qmless.numerical --> qmless.fingerprint([Fourier Fingerprints])
    qmless --> qmless.models([Models])
    qmless --> qmless.expr([Expressibility])
    qmless --> qmless.ent([Entanglement])
    qmless.ent --> qmless.mw([Meyer Wallach])
    qmless.ent --> qmless.re([Relative Entropy])
    qmless.ent --> qmless.bell([Bell Measurement])
    qmless.ent --> qmless.ef([Entanglement of Formation])
    qmless.ent --> qmless.ce([Concentratable Entanglement])

    classDef l1 fill:#1f8f5a,stroke:#1f8f5a,color:#d4f7e8
    classDef l2 fill:#2fb170,stroke:#2fb170,color:#d4f7e8
    classDef l3 fill:#58e3a6,stroke:#58e3a6,color:#272a35
    classDef l4 fill:#a8f0d1,stroke:#a8f0d1,color:#272a35

    linkStyle default stroke-width:2px

    class qmless l1
    class qmless.ansaetze,qmless.coefficients,qmless.models,qmless.expr,qmless.ent l2
    class qmless.blocks,qmless.gates,qmless.numerical,qmless.analytical,qmless.mw,qmless.bell,qmless.ef,qmless.re,qmless.ce l3
    class qmless.unitary,qmless.pulse,qmless.topo,qmless.fcc,qmless.fingerprint l4

🚧 Contributing

Contributions are highly welcome! 🤗 Take a look at our Contribution Guidelines.

See our coverage report if you would like to contribute with further tests.