Skip to main content

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

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.

Circuit simulation is provided by jaqsi, our gate- and pulse-level simulator, which this package builds upon.

flowchart LR
    qmless([QML Essentials])
    qmless --> qmless.ansaetze([Ansaetze])
    qmless.ansaetze --> qmless.blocks([Blocks])
    qmless.blocks --> qmless.topo([Topologies])
    qmless.blocks --> jaqsi.gates([Gates])
    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.models --> jaqsi.script([Script])
    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])

    subgraph jaqsi [jaqsi]
        jaqsi.gates
        jaqsi.script
    end

    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.numerical,qmless.analytical,qmless.mw,qmless.bell,qmless.ef,qmless.re,qmless.ce l3
    class qmless.topo,qmless.fcc,qmless.fingerprint,jaqsi.gates,jaqsi.script 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.

Metadata

Release files for qml-essentials 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qml-essentials 0.3.2
File Size Uploaded Provenance Actions
qml_essentials-0.3.2.tar.gz 4.5 MB Without provenance Details for qml_essentials-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qml-essentials 0.3.2
File Interpreter ABI Platform Actions
qml_essentials-0.3.2-py3-none-any.whl Python 3 none any Details for qml_essentials-0.3.2-py3-none-any.whl

Total release size: 4.6 MB

Release files / qml_essentials-0.3.2.tar.gz

Download URL qml_essentials-0.3.2.tar.gz
Size 4.5 MB
Tags Source
SHA-256 checksum
How to use checksums
901f51e5bbfe6789bdd753c9aa460d7be5e8acbed5516fa5913b66bf9677e20c
BLAKE2b-256 checksum
How to use checksums
5016d9b89f943f8a74b7706ab6bb8ca306a923e09051ce468ddfc49e823421ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / qml_essentials-0.3.2-py3-none-any.whl

Download URL qml_essentials-0.3.2-py3-none-any.whl
Size 85.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3dfa5ca82edf579a899ff3c89c622b859b5c601bc737bdc877f67db86506a238
BLAKE2b-256 checksum
How to use checksums
3abc74463570b450eb4111091dd63e959c47901dd2762974c9a9e4df638baf63
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for qml-essentials 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page