feat: execute several circuits with a single call to "run"

Author: JulienCalistoTD

mpqp/execution/result.py

@@ -195,7 +195,7 @@ class Result:
     Examples:
         >>> job = Job(JobType.STATE_VECTOR, QCircuit(2), ATOSDevice.MYQLM_CLINALG)
         >>> print(Result(job, StateVector(np.array([1, 1, 1, -1], dtype=np.complex64) / 2, 2), 0, 0)) # doctest: +NORMALIZE_WHITESPACE
-        Result: ATOSDevice, MYQLM_CLINALG
+        Result: None, ATOSDevice, MYQLM_CLINALG
          State vector: [0.5, 0.5, 0.5, -0.5]
          Probabilities: [0.25, 0.25, 0.25, 0.25]
          Number of qubits: 2
@@ -204,7 +204,7 @@ class Result:
         ...     Sample(2, index=0, count=250),
         ...     Sample(2, index=3, count=250)
         ... ], 0.034, 500)) # doctest: +NORMALIZE_WHITESPACE
-        Result: ATOSDevice, MYQLM_CLINALG
+        Result: None, ATOSDevice, MYQLM_CLINALG
          Counts: [250, 0, 0, 250]
          Probabilities: [0.5, 0, 0, 0.5]
          Samples:
@@ -213,7 +213,7 @@ class Result:
          Error: 0.034
         >>> job = Job(JobType.OBSERVABLE, QCircuit(2), ATOSDevice.MYQLM_CLINALG)
         >>> print(Result(job, -3.09834, 0.021, 2048)) # doctest: +NORMALIZE_WHITESPACE
-        Result: ATOSDevice, MYQLM_CLINALG
+        Result: None, ATOSDevice, MYQLM_CLINALG
          Expectation value: -3.09834
          Error/Variance: 0.021
 
@@ -373,7 +373,9 @@ def counts(self) -> list[int]:
         return self._counts
 
     def __str__(self):
-        header = f"Result: {type(self.device).__name__}, {self.device.name}"
+        header = (
+            f"Result: {self.job.circuit.label}, {type(self.device).__name__}, {self.device.name}"
+        )
 
         if self.job.job_type == JobType.SAMPLE:
             samples_str = "\n".join(map(lambda s: f"  {s}", self.samples))
@@ -483,22 +485,22 @@ class BatchResult:
         >>> batch_result = BatchResult([result1, result2, result3])
         >>> print(batch_result)
         BatchResult: 3 results
-        Result: ATOSDevice, MYQLM_PYLINALG
+        Result: None, ATOSDevice, MYQLM_PYLINALG
          State vector: [0.5, 0.5, 0.5, -0.5]
          Probabilities: [0.25, 0.25, 0.25, 0.25]
          Number of qubits: 2
-        Result: ATOSDevice, MYQLM_PYLINALG
+        Result: None, ATOSDevice, MYQLM_PYLINALG
          Counts: [250, 0, 0, 250]
          Probabilities: [0.5, 0, 0, 0.5]
          Samples:
           State: 00, Index: 0, Count: 250, Probability: 0.5
           State: 11, Index: 3, Count: 250, Probability: 0.5
          Error: 0.034
-        Result: ATOSDevice, MYQLM_PYLINALG
+        Result: None, ATOSDevice, MYQLM_PYLINALG
          Expectation value: -3.09834
          Error/Variance: 0.021
         >>> print(batch_result[0])
-        Result: ATOSDevice, MYQLM_PYLINALG
+        Result: None, ATOSDevice, MYQLM_PYLINALG
          State vector: [0.5, 0.5, 0.5, -0.5]
          Probabilities: [0.25, 0.25, 0.25, 0.25]
          Number of qubits: 2

mpqp/execution/runner.py

@@ -199,7 +199,7 @@ def _run_single(
 
 @typechecked
 def run(
-    circuit: QCircuit,
+    circuit: OneOrMany[QCircuit],
     device: OneOrMany[AvailableDevice],
     values: Optional[dict[Expr | str, Complex]] = None,
 ) -> Union[Result, BatchResult]:
@@ -220,49 +220,69 @@ def run(
 
     Examples:
         >>> c = QCircuit(
-        ...     [H(0), CNOT(0, 1), BasisMeasure([0, 1], shots=1000)],
-        ...     label="Bell pair",
+        ...     [X(0), CNOT(0, 1), BasisMeasure([0, 1], shots=1000)],
+        ...     label="X CNOT circuit",
         ... )
         >>> result = run(c, IBMDevice.AER_SIMULATOR)
-        >>> print(result) # doctest: +SKIP
-        Result: IBMDevice, AER_SIMULATOR
-         Counts: [497, 0, 0, 503]
-         Probabilities: [0.497, 0, 0, 0.503]
+        >>> print(result)
+        Result: X CNOT circuit, IBMDevice, AER_SIMULATOR
+         Counts: [0, 0, 0, 1000]
+         Probabilities: [0, 0, 0, 1]
          Samples:
-          State: 00, Index: 0, Count: 497, Probability: 0.497
-          State: 11, Index: 3, Count: 503, Probability: 0.503
+          State: 11, Index: 3, Count: 1000, Probability: 1.0
          Error: None
         >>> batch_result = run(
         ...     c,
         ...     [ATOSDevice.MYQLM_PYLINALG, AWSDevice.BRAKET_LOCAL_SIMULATOR]
         ... )
-        >>> print(batch_result) # doctest: +SKIP
+        >>> print(batch_result)
+        BatchResult: 2 results
+        Result: X CNOT circuit, AWSDevice, BRAKET_LOCAL_SIMULATOR
+         Counts: [0, 0, 0, 1000]
+         Probabilities: [0, 0, 0, 1]
+         Samples:
+          State: 11, Index: 3, Count: 1000, Probability: 1.0
+         Error: None
+        Result: X CNOT circuit, ATOSDevice, MYQLM_PYLINALG
+         Counts: [0, 0, 0, 1000]
+         Probabilities: [0, 0, 0, 1]
+         Samples:
+          State: 11, Index: 3, Count: 1000, Probability: 1.0
+         Error: 0.0
+        >>> c2 = QCircuit(
+        ...     [X(0), X(1), BasisMeasure([0, 1], shots=1000)],
+        ...     label="X circuit",
+        ... )
+        >>> result = run([c,c2], IBMDevice.AER_SIMULATOR)
+        >>> print(result)
         BatchResult: 2 results
-        Result: ATOSDevice, MYQLM_PYLINALG
-         Counts: [499, 0, 0, 501]
-         Probabilities: [0.499, 0, 0, 0.501]
+        Result: X CNOT circuit, IBMDevice, AER_SIMULATOR
+         Counts: [0, 0, 0, 1000]
+         Probabilities: [0, 0, 0, 1]
          Samples:
-          State: 00, Index: 0, Count: 499, Probability: 0.499
-          State: 11, Index: 3, Count: 501, Probability: 0.501
-         Error: 0.01581926829057682
-        Result: AWSDevice, BRAKET_LOCAL_SIMULATOR
-         Counts: [502, 0, 0, 498]
-         Probabilities: [0.502, 0, 0, 0.498]
+          State: 11, Index: 3, Count: 1000, Probability: 1.0
+         Error: None
+        Result: X circuit, IBMDevice, AER_SIMULATOR
+         Counts: [0, 0, 0, 1000]
+         Probabilities: [0, 0, 0, 1]
          Samples:
-          State: 00, Index: 0, Count: 502, Probability: 0.502
-          State: 11, Index: 3, Count: 498, Probability: 0.498
+          State: 11, Index: 3, Count: 1000, Probability: 1.0
          Error: None
 
     """
-
     if values is None:
         values = {}
 
-    if isinstance(device, Iterable):
-        return BatchResult([_run_single(circuit, dev, values) for dev in set(device)])
-
-    return _run_single(circuit, device, values)
-
+    if isinstance(circuit, Iterable):
+        if isinstance(device, Iterable):
+            return BatchResult([_run_single(circ, device, values) for circ in circuit for device in set(device)])
+        else:
+            return BatchResult([_run_single(circ, device, values) for circ in circuit])
+    else:
+        if isinstance(device, Iterable):
+            return BatchResult([_run_single(circuit, device, values) for device in set(device)])
+        else:
+            return _run_single(circuit, device, values)
 
 @typechecked
 def submit(