Update plugin for ProjectQ v0.5.1 support, including IBM API v2

.github/CHANGELOG.md

@@ -8,12 +8,21 @@
 
 ### Documentation
 
+* The documentation theme has been updated, and the documentation structure
+  reorganized.
+  [(#60)](https://github.com/XanaduAI/pennylane-pq/pull/60)
+
 ### Bug fixes
 
+* Updated the plugin to use the latest IBMQBackend from ProjectQ.
+  [(#62)](https://github.com/XanaduAI/pennylane-pq/pull/61)
+
 ### Contributors
 
 This release contains contributions from (in alphabetical order):
 
+Maria Schuld
+
 ---
 
 # Release 0.8.0

pennylane_pq/devices.py

@@ -378,10 +378,9 @@ class ProjectQIBMBackend(_ProjectQDevice):
         (instead of using the IBM simulator)
       num_runs (int): Number of runs to collect statistics (default is 1024).
         Is equivalent to but takes preference over the shots parameter.
-      user (string): IBM Quantum Experience user name
-      password (string): IBM Quantum Experience password
-      device (string): Device to use (‘ibmqx4’, or ‘ibmqx5’) if
-        :code:`use_hardware` is set to True. Default is 'ibmqx4'.
+      token (string): IBM Quantum Experience API token
+      device (string): IBMQ backend to use (ibmq_16_melbourne’, ‘ibmqx2’, 'ibmq_rome' 'ibmq_qasm_simulator') if
+        :code:`use_hardware` is set to True. Default is '‘ibmqx5’'.
       retrieve_execution (int): Job ID to retrieve instead of re-running
         a circuit (e.g., if previous run timed out).
       verbose (bool): If True, log messages are printed and exceptions are more verbose.
@@ -391,7 +390,7 @@ class ProjectQIBMBackend(_ProjectQDevice):
     .. code-block:: python
 
         import pennylane as qml
-        dev = qml.device('projectq.ibm', wires=XXX, user="XXX", password="XXX")
+        dev = qml.device('projectq.ibm', wires=XXX, token="XXX")
 
     To avoid leaking your user name and password when sharing code,
     it is better to specify the user name and password in your
@@ -443,15 +442,12 @@ class ProjectQIBMBackend(_ProjectQDevice):
                                  CZ, Rot, BasisState]}
     _observable_map = dict({key:val for key, val in _operation_map.items() if val in [HGate, XGate, YGate, ZGate]}, **{'Identity': None})
     _circuits = {}
-    _backend_kwargs = ['use_hardware', 'num_runs', 'verbose', 'user', 'password', 'device',
-                       'retrieve_execution']
+    _backend_kwargs = ['use_hardware', 'num_runs', 'verbose', 'token', 'device', 'retrieve_execution']
 
     def __init__(self, wires=1, shots=1024, **kwargs):
         # check that necessary arguments are given
-        if 'user' not in kwargs:
-            raise ValueError('An IBM Quantum Experience user name specified via the "user" keyword argument is required') #pylint: disable=line-too-long
-        if 'password' not in kwargs:
-            raise ValueError('An IBM Quantum Experience password specified via the "password" keyword argument is required') #pylint: disable=line-too-long
+        if 'token' not in kwargs:
+            raise ValueError('An IBM Quantum Experience token specified via the "token" keyword argument is required') #pylint: disable=line-too-long
 
         import projectq.setups.ibm #pylint: disable=unused-variable
 
@@ -462,7 +458,10 @@ def reset(self):
         """Reset/initialize the device by initializing the backend and engine, and allocating qubits.
         """
         backend = pq.backends.IBMBackend(num_runs=self.shots, **self.filter_kwargs_for_backend(self._kwargs))
-        self._eng = pq.MainEngine(backend, verbose=self._kwargs['verbose'], engine_list=pq.setups.ibm.get_engine_list())
+        token = self._kwargs.get("token", "")
+        hw = self._kwargs.get("use_hardware", False)
+        device = self._kwargs.get("device", "ibmq_qasm_simulator" if not hw else "ibmqx2")
+        self._eng = pq.MainEngine(backend, verbose=self._kwargs['verbose'], engine_list=pq.setups.ibm.get_engine_list(token=token, device=device))
         super().reset()
 
     def pre_measure(self):

requirements.txt

@@ -1,2 +1,3 @@
-projectq
+git+https://github.com/ProjectQ-Framework/ProjectQ.git#egg=projectq
 pennylane>=0.6
+pybind11

tests/test_basis_state.py

@@ -46,10 +46,12 @@ def setUp(self):
             self.devices.append(ProjectQSimulator(wires=self.num_subsystems, verbose=True))
         if self.args.device == 'ibm' or self.args.device == 'all':
             ibm_options = pennylane.default_config['projectq.ibm']
-            if "user" in ibm_options and "password" in ibm_options:
-                self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8*1024, user=ibm_options['user'], password=ibm_options['password'], verbose=True))
+            if "token" in ibm_options:
+                self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8*1024,
+                                                       token=ibm_options['token'], verbose=True))
             else:
-                log.warning("Skipping test of the ProjectQIBMBackend device because IBM login credentials could not be found in the PennyLane configuration file.")
+                log.warning("Skipping test of the ProjectQIBMBackend device because IBM login "
+                            "credentials could not be found in the PennyLane configuration file.")
         if self.args.device == 'classical' or self.args.device == 'all':
             self.devices.append(ProjectQClassicalSimulator(wires=self.num_subsystems, verbose=True))
 

tests/test_compare_with_default_qubit.py

@@ -48,10 +48,12 @@ def setUp(self):
             self.devices.append(ProjectQSimulator(wires=self.num_subsystems, shots=20000000, verbose=True))
         if self.args.device == 'ibm' or self.args.device == 'all':
             ibm_options = pennylane.default_config['projectq.ibm']
-            if "user" in ibm_options and "password" in ibm_options:
-                self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8*1024, user=ibm_options['user'], password=ibm_options['password'], verbose=True))
+            if "token" in ibm_options:
+                self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8*1024,
+                                                       token=ibm_options['token'], verbose=True))
             else:
-                log.warning("Skipping test of the ProjectQIBMBackend device because IBM login credentials could not be found in the PennyLane configuration file.")
+                log.warning("Skipping test of the ProjectQIBMBackend device because IBM login credentials "
+                            "could not be found in the PennyLane configuration file.")
         if self.args.device == 'classical' or self.args.device == 'all':
             self.devices.append(ProjectQClassicalSimulator(wires=self.num_subsystems, verbose=True))
 
@@ -74,6 +76,9 @@ class IgnoreOperationException(Exception):
 
             # run all single operation circuits
             for operation in dev.operations:
+                if operation in ("DiagonalQubitUnitary"):
+                    continue
+
                 for observable in dev.observables:
                     log.info("Running device "+dev.short_name+" with a circuit consisting of a "+operation+" Operation followed by a "+observable+" Expectation")
 

tests/test_device_initialization.py

@@ -27,35 +27,36 @@
 import pennylane_pq
 import pennylane_pq.expval
 from pennylane_pq.devices import ProjectQSimulator, ProjectQClassicalSimulator, ProjectQIBMBackend
+import os
+
+token = os.environ.get("IBMQX_TOKEN", "")
 
 log.getLogger('defaults')
 
 
+
 class DeviceInitialization(BaseTest):
     """test aspects of the device initialization.
     """
 
     num_subsystems = 4
     devices = None
 
-    def test_ibm_no_user(self):
+    def test_ibm_no_token(self):
         if self.args.device == 'ibm' or self.args.device == 'all':
-            self.assertRaises(ValueError, ProjectQIBMBackend, wires=self.num_subsystems, use_hardware=False, password='password')
-
-    def test_ibm_no_password(self):
-        if self.args.device == 'ibm' or self.args.device == 'all':
-            self.assertRaises(ValueError, ProjectQIBMBackend, wires=self.num_subsystems, use_hardware=False, user='user')
+            self.assertRaises(ValueError, ProjectQIBMBackend, wires=self.num_subsystems, use_hardware=False)
 
     def test_shots(self):
         if self.args.device == 'ibm' or self.args.device == 'all':
             shots = 5
-            dev1 = ProjectQIBMBackend(wires=self.num_subsystems, shots=shots, use_hardware=False, user="user", password='password')
+            dev1 = ProjectQIBMBackend(wires=self.num_subsystems, shots=shots, use_hardware=False, token=token, verbose=True)
             self.assertEqual(shots, dev1.shots)
 
-            dev2 = ProjectQIBMBackend(wires=self.num_subsystems, num_runs=shots, use_hardware=False, user="user", password='password')
+            dev2 = ProjectQIBMBackend(wires=self.num_subsystems, num_runs=shots, use_hardware=False, token=token)
             self.assertEqual(shots, dev2.shots)
 
-            dev2 = ProjectQIBMBackend(wires=self.num_subsystems, shots=shots+2, num_runs=shots, use_hardware=False, user="user", password='password')
+            dev2 = ProjectQIBMBackend(wires=self.num_subsystems, shots=shots+2, num_runs=shots, use_hardware=False,
+                                      token=token)
             self.assertEqual(shots, dev2.shots)
 
     def test_initiatlization_via_pennylane(self):
@@ -65,10 +66,11 @@ def test_initiatlization_via_pennylane(self):
                 'projectq.ibm'
         ]:
             try:
-                dev = dev = qml.device(short_name, wires=2, user='user', password='password', verbose=True)
+                dev = qml.device(short_name, wires=2, token=token, verbose=True)
             except DeviceError:
                 raise Exception("This test is expected to fail until pennylane-pq is installed.")
 
+
 if __name__ == '__main__':
     print('Testing PennyLane ProjectQ Plugin version ' + qml.version() + ', device initialization.')
     # run the tests in this file

tests/test_docs.py

@@ -26,7 +26,9 @@
 import pennylane_pq
 import pennylane_pq.expval
 from pennylane_pq.devices import ProjectQSimulator, ProjectQClassicalSimulator, ProjectQIBMBackend
+import os
 
+token = os.environ.get("IBMQX_TOKEN", "")
 log.getLogger('defaults')
 
 class DocumentationTest(BaseTest):
@@ -45,11 +47,8 @@ def setUp(self):
             self.devices.append(ProjectQSimulator(wires=self.num_subsystems))
             self.devices.append(ProjectQSimulator(wires=self.num_subsystems, shots=20000000))
         if self.args.device == 'ibm' or self.args.device == 'all':
-            ibm_options = pennylane.default_config['projectq.ibm']
-            if "user" in ibm_options and "password" in ibm_options:
-                self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8*1024, user=ibm_options['user'], password=ibm_options['password']))
-            else:
-                self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8*1024, user='user', password='password'))
+            self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8 * 1024,
+                                                   token=token, verbose=True))
         if self.args.device == 'classical' or self.args.device == 'all':
             self.devices.append(ProjectQClassicalSimulator(wires=self.num_subsystems))
 

tests/test_ibm_expval_and_pre_expval_mock.py

@@ -27,7 +27,9 @@
 import pennylane_pq.expval
 from pennylane_pq.devices import ProjectQSimulator, ProjectQClassicalSimulator, ProjectQIBMBackend
 from unittest.mock import patch, MagicMock, PropertyMock, call
+import os
 
+token = os.environ.get("IBMQX_TOKEN", "")
 log.getLogger('defaults')
 
 class ExpvalAndPreExpvalMock(BaseTest):
@@ -51,7 +53,7 @@ def test_pre_measure(self):
                 mock_PauliY,
                 mock_Hadamard,
             ]
-            dev = ProjectQIBMBackend(wires=2, use_hardware=False, num_runs=8*1024, user='user', password='password', verbose=True)
+            dev = ProjectQIBMBackend(wires=2, use_hardware=False, num_runs=8*1024, token=token, verbose=True)
             dev._eng = MagicMock()
             dev.apply = MagicMock()
 
@@ -77,7 +79,7 @@ def test_pre_measure(self):
 
     def test_expval(self):
 
-        dev = ProjectQIBMBackend(wires=2, use_hardware=False, num_runs=8*1024, user='user', password='password', verbose=True)
+        dev = ProjectQIBMBackend(wires=2, use_hardware=False, num_runs=8*1024, token=token, verbose=True)
         dev._eng = MagicMock()
         dev._eng.backend = MagicMock()
         dev._eng.backend.get_probabilities = MagicMock()
@@ -95,7 +97,7 @@ class Expval(BaseTest):
     def test_expval_exception_if_no_obs_queue(self):
 
         if self.args.device == 'ibm' or self.args.device == 'all':
-            dev = ProjectQIBMBackend(wires=2, shots=1, use_hardware=False, user='user', password='password', verbose=True)
+            dev = ProjectQIBMBackend(wires=2, shots=1, use_hardware=False, token=token, verbose=True)
         else:
             return
 

tests/test_unsupported_operations.py

@@ -46,10 +46,12 @@ def setUp(self):
             self.devices.append(ProjectQSimulator(wires=self.num_subsystems, verbose=True))
         if self.args.device == 'ibm' or self.args.device == 'all':
             ibm_options = pennylane.default_config['projectq.ibm']
-            if "user" in ibm_options and "password" in ibm_options:
-                self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8*1024, user=ibm_options['user'], password=ibm_options['password'], verbose=True))
+            if "token" in ibm_options:
+                self.devices.append(ProjectQIBMBackend(wires=self.num_subsystems, use_hardware=False, num_runs=8 * 1024,
+                                                       token=ibm_options['token'], verbose=True))
             else:
-                log.warning("Skipping test of the ProjectQIBMBackend device because IBM login credentials could not be found in the PennyLane configuration file.")
+                log.warning("Skipping test of the ProjectQIBMBackend device because IBM login credentials "
+                            "could not be found in the PennyLane configuration file.")
         if self.args.device == 'classical' or self.args.device == 'all':
             self.devices.append(ProjectQClassicalSimulator(wires=self.num_subsystems, verbose=True))
 

tests/test_var.py

@@ -22,6 +22,9 @@
 
 from defaults import TOLERANCE
 from pennylane_pq.devices import ProjectQSimulator, ProjectQClassicalSimulator, ProjectQIBMBackend
+import os
+
+token = os.environ.get("IBMQX_TOKEN", "")
 
 
 @pytest.fixture
@@ -45,8 +48,7 @@ def dev(DevClass, monkeypatch):
             wires=1,
             use_hardware=False,
             num_runs=8 * 1024,
-            user="user",
-            password="password",
+            token=token,
             verbose=True,
         )