Open v0.3 API + debiasing

CHANGELOG.md

@@ -4,6 +4,11 @@
 
 ### Improvements 🛠
 
+* adds a new `error_mitigation` parameter on IonQ job submission so users can
+  configure strategies
+* adds a new `aggregation` parameter on IonQ results to allow getting results
+  aggregated under the two different methods described in
+  <https://arxiv.org/pdf/2301.07233.pdf>
 * Use new `backend` field to specify `qpu`.
   [(#81)](https://github.com/PennyLaneAI/PennyLane-IonQ/pull/81)
 

pennylane_ionq/api_client.py

@@ -112,12 +112,16 @@
         api_key (str): IonQ cloud platform API key
     """
 
-    USER_AGENT = "pennylane-ionq-api-client/0.1"
-    HOSTNAME = "api.ionq.co/v0.1"
+    USER_AGENT = "pennylane-ionq-api-client/0.3"
+    HOSTNAME = "api.ionq.co/v0.3"
     BASE_URL = "https://{}".format(HOSTNAME)
 
     def __init__(self, **kwargs):
-        self.AUTHENTICATION_TOKEN = os.getenv("IONQ_API_KEY") or kwargs.get("api_key", None)
+        self.AUTHENTICATION_TOKEN = (
+            kwargs.get("api_key", None)
+            or os.getenv("PENNYLANE_IONQ_API_KEY")
+            or os.getenv("IONQ_API_KEY")
+        )
         self.DEBUG = False
 
         if "IONQ_DEBUG" in os.environ:
@@ -196,17 +200,18 @@
 
         return response
 
-    def get(self, path):
+    def get(self, path, params=None):
         """
         Sends a GET request to the provided path. Returns a response object.
 
         Args:
             path (str): path to send the GET request to
+            params (dict): parameters to include in the request
 
         Returns:
             requests.Response: A response object, or None if no response could be fetched
         """
-        return self.request(requests.get, url=self.join_path(path))
+        return self.request(requests.get, url=self.join_path(path), params=params)
 
     def post(self, path, payload):
         """
@@ -249,7 +254,7 @@
         """
         return join_path(self.resource.PATH, path)
 
-    def get(self, resource_id=None):
+    def get(self, resource_id=None, params=None):
         """
         Attempts to retrieve a particular record by sending a GET
         request to the appropriate endpoint. If successful, the resource
@@ -262,9 +267,9 @@
             raise MethodNotSupportedException("GET method on this resource is not supported")
 
         if resource_id is not None:
-            response = self.client.get(self.join_path(str(resource_id)))
+            response = self.client.get(self.join_path(str(resource_id)), params=params)
         else:
-            response = self.client.get(self.resource.PATH)
+            response = self.client.get(self.resource.PATH, params=params)
         self.handle_response(response)
 
     def create(self, **params):
@@ -337,7 +342,7 @@
     def refresh_data(self, data):
         """
         Refreshes the instance's attributes with the provided data and
         converts it to the correct type.
 
         Args:
             data (dict): A dictionary containing keys and values of data to be stored on the object.

pennylane_ionq/device.py

@@ -14,7 +14,7 @@
 """
 This module contains the device class for constructing IonQ devices for PennyLane.
 """
 import os, warnings
 from time import sleep
 
 import numpy as np
@@ -91,14 +91,26 @@
     # and therefore does not support the Hermitian observable.
     observables = {"PauliX", "PauliY", "PauliZ", "Hadamard", "Identity"}
 
-    def __init__(self, wires, *, target="simulator", gateset="qis", shots=1024, api_key=None):
+    def __init__(
+        self,
+        wires,
+        *,
+        target="simulator",
+        gateset="qis",
+        shots=1024,
+        api_key=None,
+        error_mitigation=None,
+        sharpen=None,
+    ):
         if shots is None:
             raise ValueError("The ionq device does not support analytic expectation values.")
 
         super().__init__(wires=wires, shots=shots)
         self.target = target
         self.api_key = api_key
         self.gateset = gateset
+        self.error_mitigation = error_mitigation
+        self.sharpen = sharpen
         self._operation_map = _GATESET_OPS[gateset]
         self.reset()
 
@@ -107,16 +119,25 @@
         self._prob_array = None
         self.histogram = None
         self.circuit = {
+            "format": "ionq.circuit.v0",
             "qubits": self.num_wires,
             "circuit": [],
             "gateset": self.gateset,
         }
         self.job = {
-            "lang": "json",
-            "body": self.circuit,
+            "input": self.circuit,
             "target": self.target,
             "shots": self.shots,
         }
+        if self.error_mitigation is not None:
+            self.job["error_mitigation"] = self.error_mitigation
+        if self.job["target"] == "qpu":
+            self.job["target"] = "qpu.harmony"
+            warnings.warn(
+                "The ionq_qpu backend is deprecated. Defaulting to ionq_qpu.harmony.",
+                UserWarning,
+                stacklevel=2,
+            )
 
     @property
     def operations(self):
@@ -190,7 +211,9 @@
             if job.is_failed:
                 raise JobExecutionError("Job failed")
 
-        job.manager.get(job.id.value)
+        params = {} if self.sharpen is None else {"sharpen": self.sharpen}
+
+        job.manager.get(resource_id=job.id.value, params=params)
 
         # The returned job histogram is of the form
         # dict[str, float], and maps the computational basis
@@ -287,9 +310,11 @@
         wires,
         *,
         target="qpu",
-        backend=None,
         gateset="qis",
         shots=1024,
+        backend=None,
+        error_mitigation=None,
+        sharpen=None,
         api_key=None,
     ):
         self.backend = backend
@@ -301,6 +326,8 @@
             gateset=gateset,
             shots=shots,
             api_key=api_key,
+            error_mitigation=error_mitigation,
+            sharpen=sharpen,
         )
 
     def generate_samples(self):

tests/test_api_client.py

@@ -303,12 +303,16 @@ def mock_raise(exception):
         mock_get_response = MockGETResponse(200)
 
         monkeypatch.setattr(
-            requests, "get", lambda url, timeout, headers: mock_get_response
+            requests,
+            "get",
+            lambda url, params=None, timeout=None, headers=None: mock_get_response,
         )
         monkeypatch.setattr(
             requests,
             "post",
-            lambda url, timeout, headers, data: mock_raise(MockException),
+            lambda url, data=None, timeout=None, headers=None: mock_raise(
+                MockException
+            ),
         )
 
         client = api_client.APIClient(debug=True, api_key="test")

tests/test_device.py

@@ -121,7 +121,7 @@ def test_shots(self, shots, monkeypatch, mocker, tol):
         )
         monkeypatch.setattr(Job, "is_complete", True)
 
-        def fake_response(self, resource_id=None):
+        def fake_response(self, resource_id=None, params=None):
             """Return fake response data"""
             fake_json = {"histogram": {"0": 1}}
             setattr(
@@ -216,13 +216,13 @@ def mock_submit_job(*args):
 
         dev.apply(tape.operations)
 
-        assert dev.job["lang"] == "json"
-        assert dev.job["body"]["gateset"] == "qis"
+        assert dev.job["input"]["format"] == "ionq.circuit.v0"
+        assert dev.job["input"]["gateset"] == "qis"
         assert dev.job["target"] == "foo"
-        assert dev.job["body"]["qubits"] == 1
+        assert dev.job["input"]["qubits"] == 1
 
-        assert len(dev.job["body"]["circuit"]) == 1
-        assert dev.job["body"]["circuit"][0] == {"gate": "x", "target": 0}
+        assert len(dev.job["input"]["circuit"]) == 1
+        assert dev.job["input"]["circuit"][0] == {"gate": "x", "target": 0}
 
     def test_parameterized_op(self, mocker):
         """Tests job attribute several parameterized operations."""
@@ -239,17 +239,17 @@ def mock_submit_job(*args):
 
         dev.apply(tape.operations)
 
-        assert dev.job["lang"] == "json"
-        assert dev.job["body"]["gateset"] == "qis"
-        assert dev.job["body"]["qubits"] == 1
+        assert dev.job["input"]["format"] == "ionq.circuit.v0"
+        assert dev.job["input"]["gateset"] == "qis"
+        assert dev.job["input"]["qubits"] == 1
 
-        assert len(dev.job["body"]["circuit"]) == 2
-        assert dev.job["body"]["circuit"][0] == {
+        assert len(dev.job["input"]["circuit"]) == 2
+        assert dev.job["input"]["circuit"][0] == {
             "gate": "rx",
             "target": 0,
             "rotation": 1.2345,
         }
-        assert dev.job["body"]["circuit"][1] == {
+        assert dev.job["input"]["circuit"][1] == {
             "gate": "ry",
             "target": 0,
             "rotation": 2.3456,
@@ -269,24 +269,24 @@ def mock_submit_job(*args):
             GPI2(0.2, wires=[1])
             MS(0.2, 0.3, wires=[1, 2])
 
-        assert dev.job["lang"] == "json"
-        assert dev.job["body"]["gateset"] == "native"
-        assert dev.job["body"]["qubits"] == 3
-
         dev.apply(tape.operations)
 
-        assert len(dev.job["body"]["circuit"]) == 3
-        assert dev.job["body"]["circuit"][0] == {
+        assert dev.job["input"]["format"] == "ionq.circuit.v0"
+        assert dev.job["input"]["gateset"] == "native"
+        assert dev.job["input"]["qubits"] == 3
+
+        assert len(dev.job["input"]["circuit"]) == 3
+        assert dev.job["input"]["circuit"][0] == {
             "gate": "gpi",
             "target": 0,
             "phase": 0.1,
         }
-        assert dev.job["body"]["circuit"][1] == {
+        assert dev.job["input"]["circuit"][1] == {
             "gate": "gpi2",
             "target": 1,
             "phase": 0.2,
         }
-        assert dev.job["body"]["circuit"][2] == {
+        assert dev.job["input"]["circuit"][2] == {
             "gate": "ms",
             "targets": [1, 2],
             "phases": [0.2, 0.3],