Issue Templates
To ensure scientific rigor and consistent data collection, the Quantum Advantage Tracker (QAT) utilizes structured GitHub Issue Templates. These templates act as the primary interface for researchers to submit experimental results. By using YAML-based issue forms, the project enforces specific data requirements for each of the three primary pathways to quantum advantage.
Submission Pathways
When opening a new submission ticket, you must choose the template that corresponds to your experimental methodology. Each template is designed to capture the specific metrics required for validation in that category.
1. Observable Estimations
Template: 01-submission-path-observable-estimations.yml
This pathway is for experiments reporting expectation values for specific observables. Submissions require mathematically grounded evidence of error control.
- Key Requirements:
- Circuit Instance: Reference to a specific model in the
data/observable-estimationsdirectory. - Expectation Value: The primary numerical result of the experiment.
- Error Bars: Rigorous confidence intervals or error bounds.
- Validation Method: Description of the error mitigation or suppression techniques used.
- Circuit Instance: Reference to a specific model in the
2. Variational Problems
Template: 02-submission-path-variational-problems.yml
This pathway focuses on variational algorithms (like VQE) where the goal is to find the upper bound of a ground-state energy.
- Key Requirements:
- Hamiltonian Instance: Reference to the Hamiltonian used (found in
data/variational-problems/hamiltonians). - Ground-State Energy: The calculated energy value.
- Variational Principle Evidence: Documentation showing that the ansatz and optimization process respect the variational principle.
- Optimizer Details: Parameters and classical resources used during the optimization loop.
- Hamiltonian Instance: Reference to the Hamiltonian used (found in
3. Classically Verifiable Problems
Template: 03-submission-path-classically-verifiable-problems.yml
Used for problems where the quantum output can be efficiently checked by a classical computer, even if the classical computer cannot generate the solution itself.
- Key Requirements:
- Problem Specification: Reference to the circuit model or instance.
- Verification Score: The result of the scoring against known answers or witnesses.
- Witness/Proof: Data required for a classical verifier to confirm the quantum computation was successful.
How to Submit
To contribute a new candidate to the tracker, follow these steps:
- Identify your pathway: Determine which of the three templates above fits your research.
- Select an instance: Ensure your data corresponds to an existing circuit model or Hamiltonian in the data directory.
- Open a Ticket: Navigate to the New Issue page on the GitHub repository.
- Complete the Form: Fill out all required fields in the YAML form. These fields are used to automatically populate the website's tracker tables.
Metadata Requirements
All templates require the following metadata to credit contributors properly:
- Institution(s): The organizations involved in the research.
- Publication/Preprint Link: A link to the paper (e.g., arXiv, Nature, etc.) supporting the claim.
- Creation Date: When the results were finalized.
Technical Validation
Once an issue is submitted using a template, the QAT maintainers review the entry. Because the templates are structured as YAML, the data is parsed and integrated into the following JSON files which power the site:
data/observable-estimations/submissions.jsondata/variational-problems/submissions.jsondata/classically-verifiable-problems/submissions.json