Suite Commands¶

Commands for dispatching, monitoring, and managing benchmark suites.

dispatch¶

Dispatch a suite of benchmark jobs to a quantum device.

mgym suite dispatch <suite_config> [OPTIONS]

Argument	Type	Description	Required
`SUITE_CONFIG`	STR	Path to suite configuration file	Yes

Option	Type	Description	Default
`--provider, -p`	STR	Provider name (e.g., ibm, braket, azure, ionq, local)	`None`
`--device, -d`	STR	Device identifier	`None`

Poll suite jobs and retrieve results when complete.

mgym suite poll [suite_id] [OPTIONS]

Argument	Type	Description	Required
`SUITE_ID`	STR	Suite ID to poll	No

Option	Type	Description	Default
`--json`	STR	Export results to JSON file	`None`
`--no-cache`	BOOL	Ignore locally cached results and refetch	`False`

View jobs in a suite.

mgym suite view [suite_id]

Argument	Type	Description	Required
`SUITE_ID`	STR	Suite ID to view	No

Delete all jobs in a suite from the local database.

mgym suite delete [suite_id]

Argument	Type	Description	Required
`SUITE_ID`	STR	Suite ID to delete	No

Upload suite results to GitHub via pull request.

mgym suite upload [suite_id] [OPTIONS]

Argument	Type	Description	Required
`SUITE_ID`	STR	Suite ID to upload	No

Option	Type	Description	Default
`--repo`	STR	Target GitHub repo (owner/repo) (env: `MGYM_UPLOAD_REPO`)	`unitaryfoundation/metriq-data`
`--base`	STR	Base branch for the PR (env: `MGYM_UPLOAD_BASE_BRANCH`)	`main`
`--dir`	STR	Directory in repo for the JSON file (env: `MGYM_UPLOAD_DIR`)	`None`
`--branch`	STR	Branch name for the PR	`None`
`--title`	STR	Pull request title	`None`
`--body`	STR	Pull request body	`None`
`--commit-message`	STR	Commit message	`None`
`--clone-dir`	STR	Working directory to clone into (env: `MGYM_UPLOAD_CLONE_DIR`)	`None`
`--dry-run`	BOOL	Do not push or open a PR; print actions only	`False`