Skip to main content

Describe your quantum workload. We recommend where to run it.

Project description

Qlro

Show us your quantum circuit. We'll tell you where to run it.

from qiskit import QuantumCircuit
import qlro

qc = QuantumCircuit(4)
qc.h(0); qc.cx(0, 1); qc.cx(1, 2); qc.cx(2, 3)
qc.measure_all()

result = qlro.recommend(qc, category="chemistry")
result.primary      # → 'H2-2'
result.primary_fit  # → 0.8140

Qlro is a quantum device recommendation engine. Give it a circuit and a workload type, and it ranks every available quantum device by how well that device fits your specific workload — based on real benchmark data from Metriq (Unitary Foundation), not vendor marketing.

Install

pip install qlro

Ships with a snapshot of the Metriq benchmark dataset. No API keys, no accounts, no internet required.

How it works

  1. You have a quantum circuit (Qiskit QuantumCircuit or OpenQASM string).
  2. You tell Qlro what kind of workload it is: chemistry, simulation, optimization, or ml.
  3. Qlro scores every quantum device across four capability axes:
    • Γ (Connectivity) — verified entanglement coverage across the chip
    • Φ (Coherence) — information survival over circuit depth
    • F (Fidelity) — per-operation accuracy
    • T (Throughput) — effective operations per second
  4. You get a ranked list with scores, uncertainty bands, and the Metriq commit hash so everything is auditable.

The scoring framework is called WCPP (Workload-Conditioned Physical Projection). Every number comes from physics, not heuristics. See the full specification for the math, axioms, and proofs.

What Qlro does NOT do

  • Does not run your circuit. You run it yourself on IBM Quantum, AWS Braket, Quantinuum, etc.
  • Does not build or optimize circuits. That's Classiq, Qiskit transpiler, etc.
  • Does not measure hardware. That's Metriq / Unitary Foundation. We consume their data.
  • Does not hide uncertainty. Every score shows what's measured vs. estimated vs. assumed.

Auto-logging (0.6.0+)

Every quantum-circuit execution can flow into qlro.io/accuracy automatically — no manual log_outcome() calls needed.

AWS Braket — monkey-patch the SDK once, then every run() + result() pair is instrumented:

import qlro.autolog.braket as qlbraket
qlbraket.enable()

# existing Braket code continues to work unchanged
from braket.aws import AwsDevice
device = AwsDevice("arn:aws:braket:eu-north-1::device/qpu/iqm/Garnet")
task = device.run(circuit, shots=1000)
result = task.result()          # ← auto-posts (prediction, observation)

Qiskit — wrap a backend; the proxy forwards every attribute but instruments .run():

import qlro.autolog.qiskit as qlqiskit
backend = service.backend("ibm_fez")
backend = qlqiskit.wrap(backend)

job = backend.run(circuit, shots=1024)
result = job.result()           # ← auto-posts (prediction, observation)

By default the observed fidelity is the dominant-bitstring proxy (Silver tier), which works for any circuit. Pass a custom metric for rigorous Gold-tier submissions:

def ghz_metric(counts):
    total = sum(counts.values())
    return (counts.get("0000", 0) + counts.get("1111", 0)) / total

backend = qlqiskit.wrap(backend, metric=ghz_metric)   # ← Gold-tier

Predictions and outcomes persist in a local SQLite cache at ~/.qlro/autolog.db, so a Braket task submitted today and fetched tomorrow still gets auto-posted. Auto-logging is strictly best-effort — any network or parsing error is swallowed and logged, never raised into the user's workflow.

Install the Braket extra:

pip install qlro[braket]

Qiskit is already a base dependency.

Command line

Four shell commands cover the common workflow without leaving the terminal:

# Daily — rank a circuit file
qlro recommend my_vqe.qasm --category chemistry
qlro recommend my_vqe.qasm --category optimization --all
cat my_vqe.qasm | qlro recommend - --json | jq '.rankings[0]'

# Pre-flight — check device snapshot freshness and drift
qlro doctor iqm_garnet
# Exit codes: 0 = healthy, 1 = stale (>7 days), 2 = drifted (>=2x from snapshot)

# Calibrate — recover cross-vendor RMSE 82-94% (paper §8.10.9)
qlro calibrate iqm_garnet \
  --ghz-fidelity 0.953 \
  --deep-ladder-fidelity 0.39
# Saves to ~/.qlro/calibrations/iqm_garnet.json

# Retrospective — Braket savings audit
pip install "qlro[braket]"
qlro braket-retro --days 30

qlro --help lists all subcommands; qlro <cmd> --help shows flags.

Jupyter integration

Qlro auto-renders as an inline HTML table in Jupyter notebooks. For quick interactive use:

%load_ext qlro.jupyter
%qlro my_circuit chemistry

See examples/vqe_h2_with_qlro.ipynb for a complete walkthrough.

Try the interactive simulator

Don't understand the problem Qlro solves? Play the simulator — a 5-minute browser game where you play as a quantum engineer under a paper deadline, with and without Qlro.

Update benchmark data

python scripts/sync_metriq.py

Pulls the latest from the metriq-data repository. Every recommendation is anchored to a specific Metriq commit for reproducibility.

Development

git clone https://github.com/linsletoh/qlro.git
cd qlro
pip install -e ".[dev,server]"
pytest  # 107 tests

Architecture

src/qlro/
├── scoring/          ← WCPP reference implementation
│   ├── physics.py    ← benchmark → physical value transforms
│   ├── axes.py       ← capability axis aggregation
│   ├── composition.py← workload-conditioned geometric mean
│   └── wcpp.py       ← qlro_fit() entry point
├── public_api.py     ← recommend(), log_outcome()
├── jupyter.py        ← %qlro magic for notebooks
├── runner/           ← Qiskit Aer experiment runner
├── comparison/       ← normalization pipeline
├── recommendation/   ← scoring + explanation engine
└── api.py            ← FastAPI web application

Key documents

Citation

If you use Qlro or WCPP in research, please cite the Zenodo preprint:

@misc{oh2026wcpp,
  author    = {Oh, Yeonwoo},
  title     = {{Workload-Conditioned Physical Projection: A Vendor-Neutral Framework for Quantum Device Selection}},
  year      = {2026},
  publisher = {Zenodo},
  version   = {1.1},
  doi       = {10.5281/zenodo.19785800},
  url       = {https://doi.org/10.5281/zenodo.19785800}
}

Latest version DOI: 10.5281/zenodo.19785800 (v1.1, post-reviewer round-2 strengthening of v1.0: Table 5 weight cross-reference in §8.8b; §8.10.7 "opposing directions" reframed as structural sensitivity-profile claim; Γ-Φ collinearity given direct admission with permutation p-value and v1.2 orthogonalization commitment. Main empirical results unchanged: $N = 100$ cross-vendor CSE validation, stable-snapshot subset $r = 0.964$, full aggregate $r = 0.893$; Appendix D preliminary explorations).

Concept DOI (always resolves to the latest version): 10.5281/zenodo.19601378.

Previous versions: v1.0 at 10.5281/zenodo.19726906, v0.9 at 10.5281/zenodo.19707205, v0.8 at 10.5281/zenodo.19678508, v0.7 at 10.5281/zenodo.19650211, v0.6 at 10.5281/zenodo.19622226 (archived).

License

Apache 2.0

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

qlro-0.12.0.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

qlro-0.12.0-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file qlro-0.12.0.tar.gz.

File metadata

  • Download URL: qlro-0.12.0.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for qlro-0.12.0.tar.gz
Algorithm Hash digest
SHA256 4076574abe4e0ca5876910311234bf3ad364b1b05917504324b56a52302f8aa0
MD5 7f98c725c61f0511c9f31a381f71d895
BLAKE2b-256 0fdd8fb8d4bf8593e9395502c31fccfef8e9f137c17391dd3e88e72324febffa

See more details on using hashes here.

File details

Details for the file qlro-0.12.0-py3-none-any.whl.

File metadata

  • Download URL: qlro-0.12.0-py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for qlro-0.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f066096b5e422e14a680bb7dc1324ee5a907b48cd5ad039db6d30b930bb41d72
MD5 e066d4edbabb19342dfd7462f7ebbad4
BLAKE2b-256 22eef887ee982aed52ce2148cfeea9ce6e3b2383ce87159a78a15d8d203ff04c

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