Skip to main content

Autoencoder-based error mitigation and visualization

Project description

ae-qem — Autoencoder-based Quantum Error Mitigation SDK

A lightweight SDK for mitigating measurement errors in single quantum-circuit experiments using a pretrained autoencoder, with interactive visualization via Dash/Plotly.

PyPI version Python License: MIT

Features

  • One-call workflow: measure → mitigate → visualize
  • Pretrained autoencoder checkpoints included (datasets A–F)
  • Interactive plots (toggle exact / noisy / mitigated traces)
  • Designed for single-circuit demonstration (not large batches)

Installation

pip install ae-qem

Input your first quantum circuit!

Step 1. Create your own four-qubit circuit.

from qiskit import QuantumCircuit
circ = QuantumCircuit(4)
circ.h([0])

Step 2. Use JobCenter class to manage your jobs. This class eagerly loads the autoencoder model and the user-defined weights (A to F). By providing a quantum circuit and a job_id to the add_job method, measurement and mitigation are performed automatically, and the results are saved in the instance variable jobs as a dictionary.

from ae_qem.mitigation import JobCenter
center = JobCenter(checkpoint_name="F")
# Select your own id.
center.add_job(
    circ=circ,
    job_id="0"
)

Visualization

Step 3. Provide a job ID to the visualization method to visualize the job results with a bar plot.

center.visualization(job_id="0")

Figure below presents the overall visualization:

The left panel compares the exact, noisy, and mitigated measurement outcomes using overlaid bar plots. The buttons below the figure toggle each type of measurement outcome on or off, providing a convenient environment for clear analysis. The right panel reports the mean absolute error (MAE) between the exact values and the unmitigated (noisy) outcomes, and between the exact values and the mitigated outcomes, indicating whether the autoencoder reduces errors.

Visualization

License

MIT License. See LICENSE for details.

Citation

@inproceedings{Lin2025IEEEqCCL,
  title={Quantum Error Mitigation via Autoencoder Neural Networks},
  author={Xiao-Dao Lin and Hsi-Ming Chang and Jhih-Shih You and Hsiu-Chuan Hsu},
  year=2025,
  month={June},
  booktitle={Proceedings of the IEEE International Conference on Quantum Control, Computing and Learning (IEEE qCCL2025)},
  publisher = {IEEE},
  address = {The Hong Kong Polytechnic University, Hung Hom, Kowloon, Hong Kong},
  note = {To appear; Not yet published as of August 25, 2025}
}
@mastersthesis{Lin2025MasterThesis,
  title      = {Quantum Error Mitigation via Autoencoder Neural Networks},
  author     = {Xiao-Dao Lin},
  year       = {2025},
  school     = {National Chengchi University},
  department = {Graduate Institute of Applied Physics},
  type       = {Master's thesis},
  note       = {Advisor: Hsiu-Chuan Hsu},
  language   = {zh-TW},
  url        = {http://thesis.lib.nccu.edu.tw/cgi-bin/gs32/gsweb.cgi?o=dallcdr&s=id=%22G0112755009%22.&searchmode=basic}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ae_qem-0.1.0.tar.gz (80.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ae_qem-0.1.0-py3-none-any.whl (80.2 MB view details)

Uploaded Python 3

File details

Details for the file ae_qem-0.1.0.tar.gz.

File metadata

  • Download URL: ae_qem-0.1.0.tar.gz
  • Upload date:
  • Size: 80.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for ae_qem-0.1.0.tar.gz
Algorithm Hash digest
SHA256 01a7d4449c25d944c29f8567f5f80c6d6a87f928fbabf2e2ce8b6bbc520c49b3
MD5 2c45316d7d0024ef3adbabcc2ab89e82
BLAKE2b-256 b91dadde6fde87e8b9e414c5bcc4b28afd0f76679b0fffa861a9a3e16474390b

See more details on using hashes here.

File details

Details for the file ae_qem-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ae_qem-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 80.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for ae_qem-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ed19cc482fcbfff60c2a02b6161dc4b15a93c06ac44bf0aa6057d7e77800166
MD5 412c678a6c2e5b360e1dcfe36ae7fb7d
BLAKE2b-256 756d53cea5571f299509baf756f5512a27b79310caa9e115c0f612b9bc062df2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page