Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
9974efd
feat: resource estimation workflow for benchmark jobs.
vprusso Oct 3, 2025
4f19079
Update metriq_gym/run.py
vprusso Oct 3, 2025
8892ac7
Update metriq_gym/resource_estimation.py
vprusso Oct 3, 2025
b497d18
Update metriq_gym/resource_estimation.py
vprusso Oct 3, 2025
0ef5469
Update docs/source/cli_workflows.rst
vprusso Oct 3, 2025
ca3f220
feat: resource estimation workflow for benchmark jobs.
vprusso Oct 3, 2025
d5a541d
feat: resource estimation workflow for benchmark jobs.
vprusso Oct 3, 2025
f420303
Merge branch 'main' into 559-resource-estimation-benchmark
cosenal Nov 4, 2025
996d24c
file added by mistake
cosenal Nov 4, 2025
3e93c4a
Merge branch 'main' into 559-resource-estimation-benchmark
cosenal Nov 6, 2025
790be3d
init device variable
cosenal Nov 6, 2025
4397573
Merge branch 'main' into 559-resource-estimation-benchmark
cosenal Nov 7, 2025
67c07df
delegate resource estimation to benchmarks
cosenal Nov 7, 2025
040070f
clean up unused fns
cosenal Nov 7, 2025
1f8b783
update all benchmarks to new hook
cosenal Nov 7, 2025
6c37c26
better label
cosenal Nov 10, 2025
db096df
chore: support for quantinuum and bseq
vprusso Nov 10, 2025
bc40162
refactor: use misra-gries algorithm for bseq
vprusso Nov 18, 2025
3db430a
Merge branch 'main' into 559-resource-estimation-benchmark
vprusso Nov 18, 2025
10f9000
chore: update n_measure
vprusso Nov 18, 2025
e4e35ee
fix: num_qubits add to hqc formula
vprusso Nov 18, 2025
07d908d
chore: mege main
vprusso Nov 24, 2025
868fe2a
chore: merge main
vprusso Nov 24, 2025
a6e17f9
chore: adding resource estimates to other benchmarks
vprusso Nov 24, 2025
b28d019
fix: mypy
vprusso Nov 24, 2025
6ddc73c
chore: fixing blocking dispatch and polling
vprusso Nov 25, 2025
8ee389c
chore: undo wrong commit fileg
vprusso Nov 25, 2025
fc5c71a
chore: removing TODO
vprusso Nov 26, 2025
17304e3
Merge branch 'main' into 559-resource-estimation-benchmark
vprusso Nov 27, 2025
1698686
fix: commented breaking tests now work
vprusso Nov 27, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion docs/source/cli_workflows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,30 @@ Defaults:
* Directory: ``metriq-gym/v<major.minor>/<provider>`` (override with ``--dir`` or ``MGYM_UPLOAD_DIR``)
* Uploads append records to ``results.json``

Authentication:
Estimate Job Resources
======================

Before dispatching, you can approximate the circuit footprint, gate counts, and (for
Quantinuum) HQCs:

.. code-block:: sh

mgym job estimate metriq_gym/schemas/examples/wit.example.json \
--provider quantinuum

The command prints aggregated totals and per-circuit statistics. HQCs are calculated
automatically for Quantinuum devices using the published H-series coefficients
(``HQC = 5 + C × (N₁ + 10N₂ + 5Nₘ)/5000``); for other providers, only gate counts are shown.
Benchmarks that depend on device topology (e.g. BSEQ, CLOPS, Mirror Circuits, LR-QAOA)
require ``--device`` to be supplied so the estimator can inspect connectivity.

.. code-block:: sh

mgym job estimate metriq_gym/schemas/examples/wit.example.json \
--provider ibm --device ibm_fez

Authentication
==============

* Set ``GITHUB_TOKEN`` (or ``GH_TOKEN``). External contributors should fork the data repo first.
* Token docs: https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
Expand Down
16 changes: 16 additions & 0 deletions metriq_gym/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,22 @@ def parse_arguments() -> argparse.Namespace:
help="Backend to use",
)

job_estimate = job_subparsers.add_parser("estimate", help="Estimate resources for a job")
job_estimate.add_argument("config", type=str, help="Path to job configuration file.")
job_estimate.add_argument(
"-p",
"--provider",
type=str,
choices=get_providers() + ["local"],
help="String identifier for backend provider service",
)
job_estimate.add_argument(
"-d",
"--device",
type=str,
help="Backend to use (optional for resource estimation)",
)

job_poll = job_subparsers.add_parser("poll", help="Poll job")
job_view = job_subparsers.add_parser("view", help="View job")
job_delete = job_subparsers.add_parser("delete", help="Delete job")
Expand Down
Loading