Use shots for all QED-C benchmarks (#645) (#654)

Author: bachase

metriq_gym/benchmarks/qedc_benchmarks.py

@@ -33,12 +33,12 @@
 
 """
 Type: QEDC_Metrics
-Description: 
-    The structure for all returned QED-C circuit metrics. 
+Description:
+    The structure for all returned QED-C circuit metrics.
     The first key represents the number of qubits for the group of circuits.
-    The second key represents the unique identifier for a circuit in the group. 
-        - This may be a secret string for Bernstein-Vazirani, theta value for Phase-Estimation, 
-          and so on. Benchmark specific documentation can be found in QED-C's 
+    The second key represents the unique identifier for a circuit in the group.
+        - This may be a secret string for Bernstein-Vazirani, theta value for Phase-Estimation,
+          and so on. Benchmark specific documentation can be found in QED-C's
           QC-App-Oriented-Benchmarks repository.
     The third key represents the metric being stored.
 Example for Bernstein-Vazirani:
@@ -201,8 +201,12 @@ def get_circuits_and_metrics(
     benchmark = import_benchmark_module(benchmark_name)
 
     # Call the QED-C submodule to get the circuits and creation information.
+    # Conver to QED-C parameter naming conventions.
+    qedc_params = params.copy()
+    if "shots" in qedc_params:
+        qedc_params["num_shots"] = qedc_params.pop("shots")
     circuits, circuit_metrics = benchmark.run(
-        **params,
+        **qedc_params,
         api="qiskit",
         get_circuits=True,
     )

metriq_gym/schemas/bernstein_vazirani.schema.json

@@ -1,7 +1,7 @@
 {
   "_comment": "TODO (424)",
   "$id": "metriq-gym/bernstein_vazirani.schema.json",
-  "$schema": "https://json-schema.org/draft/2020-12/schema",  
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "Bernstein-Vazirani",
   "description": "Bernstein-Vazirani benchmark schema definition, describing parameters for the benchmark.",
   "type": "object",
@@ -11,7 +11,7 @@
       "const": "Bernstein-Vazirani",
       "description": "Name of the benchmark. Must be 'Bernstein-Vazirani' for this schema."
     },
-    "num_shots": {
+    "shots": {
       "type": "integer",
       "description": "Number of measurement shots (repetitions) to use for each circuit in the benchmark.",
       "default": 1000,

metriq_gym/schemas/examples/bernstein_vazirani.example.json

@@ -1,9 +1,9 @@
 {
     "benchmark_name": "Bernstein-Vazirani",
-    "num_shots": 1000,
+    "shots": 1000,
     "min_qubits": 2,
     "max_qubits": 6,
     "skip_qubits": 1,
     "max_circuits": 3,
     "method": 1
-}
+}

metriq_gym/schemas/examples/hidden_shift.example.json

@@ -1,9 +1,9 @@
 {
     "benchmark_name": "Hidden Shift",
-    "num_shots": 1000,
+    "shots": 1000,
     "min_qubits": 2,
     "max_qubits": 6,
     "skip_qubits": 1,
     "max_circuits": 3,
     "method": 1
-}
+}

metriq_gym/schemas/examples/phase_estimation.example.json

@@ -1,10 +1,10 @@
 {
     "benchmark_name": "Phase Estimation",
-    "num_shots": 1000,
+    "shots": 1000,
     "min_qubits": 2,
     "max_qubits": 6,
     "skip_qubits": 1,
     "max_circuits": 3,
     "method": 1,
     "use_midcircuit_measurement": false
-}
+}

metriq_gym/schemas/hidden_shift.schema.json

@@ -1,7 +1,7 @@
 {
   "_comment": "TODO (424)",
   "$id": "metriq-gym/hidden_shift.schema.json",
-  "$schema": "https://json-schema.org/draft/2020-12/schema",  
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "Hidden Shift",
   "description": "Hidden Shift benchmark schema definition, describing parameters for the benchmark.",
   "type": "object",
@@ -11,7 +11,7 @@
       "const": "Hidden Shift",
       "description": "Name of the benchmark. Must be 'Hidden Shift' for this schema."
     },
-    "num_shots": {
+    "shots": {
       "type": "integer",
       "description": "Number of measurement shots (repetitions) to use for each circuit in the benchmark.",
       "default": 1000,

metriq_gym/schemas/phase_estimation.schema.json

@@ -1,7 +1,7 @@
 {
   "_comment": "TODO (424)",
   "$id": "metriq-gym/phase_estimation.schema.json",
-  "$schema": "https://json-schema.org/draft/2020-12/schema",  
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "Phase Estimation",
   "description": "Phase Estimation benchmark schema definition, describing parameters for the benchmark.",
   "type": "object",
@@ -11,7 +11,7 @@
       "const": "Phase Estimation",
       "description": "Name of the benchmark. Must be 'Phase Estimation' for this schema."
     },
-    "num_shots": {
+    "shots": {
       "type": "integer",
       "description": "Number of measurement shots (repetitions) to use for each circuit in the benchmark.",
       "default": 1000,

metriq_gym/schemas/quantum_fourier_transform.schema.json

@@ -1,7 +1,7 @@
 {
   "_comment": "TODO (424)",
   "$id": "metriq-gym/quantum_fourier_transform.schema.json",
-  "$schema": "https://json-schema.org/draft/2020-12/schema",  
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "title": "Quantum Fourier Transform",
   "description": "Quantum Fourier Transform benchmark schema definition, describing parameters for the benchmark.",
   "type": "object",
@@ -11,7 +11,7 @@
       "const": "Quantum Fourier Transform",
       "description": "Name of the benchmark. Must be 'Quantum Fourier Transform' for this schema."
     },
-    "num_shots": {
+    "shots": {
       "type": "integer",
       "description": "Number of measurement shots (repetitions) to use for each circuit in the benchmark.",
       "default": 1000,