Issue Templates & Validation
Structured Submissions via Issue Templates
The Quantum Advantage Tracker (QAT) utilizes GitHub Issue Forms to standardize the submission of experimental results. By using structured YAML templates, the project ensures that all candidates provide the necessary metadata and scientific evidence required for rigorous verification.
Available Templates
Submissions are categorized into three primary pathways. Each pathway has a dedicated issue template designed to capture the specific metrics relevant to that methodology:
| Pathway | Template File | Use Case |
| :--- | :--- | :--- |
| Observable Estimations | 01-submission-path-observable-estimations.yml | Reporting expectation values with rigorous error bars. |
| Variational Problems | 02-submission-path-variational-problems.yml | Submitting ground-state energy bounds and ansatz optimizations. |
| Classically Verifiable Problems | 03-submission-path-classically-verifiable-problems.yml | Results that can be checked against known answers or witnesses. |
Data Fields and Validation Logic
To maintain scientific integrity, each template enforces a schema that includes:
- Contributor Information: Identifying the institutions and researchers involved.
- Circuit Instance Reference: A link to the specific circuit model or Hamiltonian used (from the
data/directory). - Quantitative Results: Numerical data (e.g., energy values, expectation values) formatted for automatic parsing.
- Verification Evidence: Links to supporting materials such as arXiv preprints, GitHub repositories with raw data, or execution logs.
The Validation Workflow
Once an issue is submitted using a template, it undergoes a multi-stage validation process:
- Schema Check: The issue is automatically scanned to ensure all required fields are populated and numerical data is in the correct format.
- Scientific Peer Review: Maintainers and community contributors review the submission for technical rigor.
- For Observable Estimations: Validation requires mathematically grounded confidence intervals over the reported value.
- For Variational Problems: Submissions must demonstrate that the ansatz and optimization respect the variational principle.
- For Classically Verifiable Problems: Results are scored against known classical benchmarks or efficiently checkable witnesses.
- Data Integration: Approved submissions are merged into the repository's JSON data files (
submissions.json), which automatically updates the live trackers on the website.
How to Submit
To contribute a new advantage candidate:
- Navigate to the GitHub Issues page.
- Select the template corresponding to your research pathway.
- Fill in the form fields. Ensure that your Circuit Instance ID matches an existing entry in the QAT database or provide the specs for a new one.
- Submit the issue. You do not need to manually assign tags or labels; the system handles categorization based on the template used.
### Example Submission Snippet
Path: Observable Estimations
Instance ID: trotter_ising_n127_d20
Expectation Value: 0.452
Error Bar: ±0.003 (95% CI)
Methodology: Zero-noise extrapolation with rigorous error bounds.
Proposing New Circuit Models
If your experiment uses a circuit model or Hamiltonian not currently in our database, you should first read the Data Documentation to learn how to submit a new instance before filing your experimental results ticket.