Compatibility with 1.0 for devices #493

lillian542 · 2024-03-08T16:28:08Z

Finishing the work started before the 0.35 release of getting the devices up to date and tested with Qiskit 1.0. We continue also running the tests with Qiskit 0.45.3, to check backward compatibility.

There are a few small tweaks to source code to get it compatible, but most of that got done before last release.

This PR is mostly

CI changes to run the tests with both 1.0 and 0.45,
test changes so the backends and providers being used in tests exist and are compatible with the Qiskit version,
documentation updates, and
adding a new device because they've replaced BasicAer with BasicSimulator going forward

lillian542 · 2024-03-08T22:44:09Z

[sc-56263]

lillian542 · 2024-03-08T22:44:18Z

[sc-56126]

pennylane_qiskit/basic_aer.py

codecov · 2024-04-01T19:57:52Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (18c3c7a) to head (ec9bae5).

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #493   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         7           
  Lines          552       557    +5     
=========================================
+ Hits           552       557    +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mudit2812

One comment/question, otherwise ready to approve.

.github/workflows/tests_qiskit_1.yml

trbromley

Thanks @lillian542!

README.rst

doc/devices/basicaer.rst

pennylane_qiskit/basic_aer.py

trbromley · 2024-04-03T19:04:44Z

pennylane_qiskit/basic_aer.py

+        wires (int or Iterable[Number, str]]): Number of subsystems represented by the device,
+            or iterable that contains unique labels for the subsystems as numbers (i.e., ``[-1, 0, 2]``)
+            or strings (``['aux_wire', 'q1', 'q2']``).
+        backend (str): the desired backend


What would the other option be here?

Currently there is no other option here, but they add/change backends sometimes. Our default format for the device init functions so far has been that we don't worry about that - users can check backend options and pass what they want from the list of available backends. The list of available backends is in this case is ["basic_simulator"]. Maybe this should move to kwargs though? It's just here to match the other device signatures right now.

Right, I'd be a bit confused about the backend option. If I put backend='aer_simulator', things wouldn't work?

I'm happy to leave this in for now though, as the precedent is already set in other devices.

pennylane_qiskit/basic_aer.py

trbromley · 2024-04-03T19:05:18Z

pennylane_qiskit/basic_aer.py

+    Keyword Args:
+        name (str): The name of the circuit. Default ``'circuit'``.
+        compile_backend (BaseBackend): The backend used for compilation. If you wish
+            to simulate a device compliant circuit, you can specify a backend here.


Are these the only two kwargs one might want to use?

No, but we generally haven't documented allowed kwargs, because they are really determined by Qiskit, are backend-dependent, and we just pass them through. We don't have a complete list of options. I'll go over them and make sure we aren't missing any PennyLane specific ones though.

I can't come up with any other PennyLane kwargs we would want to include here

🤔 I'm thinking we remove these two, since I don't understand how or why I'd want to use them 😆

pennylane_qiskit/basic_aer.py

Co-authored-by: Thomas R. Bromley <[email protected]>

astralcai

Looks good

trbromley

Thanks @lillian542! Just a few more comments, but overall the PR looks good enough to merge.

trbromley · 2024-04-09T19:02:01Z

README.rst

+    By default, tests on the ``ibmq`` device run with ``ibmq_qasm_simulator`` backend. At
+    the time of writing this means that the test are "free".


Not sure what we will do here regarding this announcement 🤔 We might need to migrate to using the local integration tests.

Are these remote tests being run in the plugin test matrix?

They are running in the plugin matrix. And yes, we've started seeing warnings about that when running the tests.

Probably we will want to change our default backend for devices that currently use the ibmq_qasm_simulator to be the aer_simulator instead, since that's one of their recommended options in their migration documentation.

For our test, I think almost everything using the ibmq_qasm_simulator can also just be replaced with the aer_simulator for now. The fake providers and backends sound nice long-term, but just using aer_simulator should be pretty quick fix to keep our tests working in the meantime.

trbromley · 2024-04-09T19:07:14Z

pennylane_qiskit/basic_aer.py

+        wires (int or Iterable[Number, str]]): Number of subsystems represented by the device,
+            or iterable that contains unique labels for the subsystems as numbers (i.e., ``[-1, 0, 2]``)
+            or strings (``['aux_wire', 'q1', 'q2']``).
+        backend (str): the desired backend


Right, I'd be a bit confused about the backend option. If I put backend='aer_simulator', things wouldn't work?

I'm happy to leave this in for now though, as the precedent is already set in other devices.

pennylane_qiskit/basic_aer.py

trbromley · 2024-04-09T19:10:10Z

pennylane_qiskit/basic_aer.py

+    Keyword Args:
+        name (str): The name of the circuit. Default ``'circuit'``.
+        compile_backend (BaseBackend): The backend used for compilation. If you wish
+            to simulate a device compliant circuit, you can specify a backend here.


🤔 I'm thinking we remove these two, since I don't understand how or why I'd want to use them 😆

* update to use requirements-ci and requirements-ci-legacy * unpin qiskit-ibm-runtime * add explicit qiskit-ibm-runtime requirement * unpin in upload yaml * update changelog

lillian542 added 5 commits March 8, 2024 11:18

remove deprecated installation syntax from test yaml

6f2c067

run all the test vs Qiskit 1.0

39d1c37

update to only raise error for BasicAer

ffc33e3

add missing import

4629ac4

reorganize test parameterization for 1.0

0c257c5

lillian542 marked this pull request as ready for review March 8, 2024 16:28

lillian542 changed the title ~~Compatibility with 1.0 for devices~~ [WIP] Compatibility with 1.0 for devices Mar 8, 2024

lillian542 added 8 commits March 8, 2024 11:29

remove unused import

39f040b

add a BasicSimulator device

281088e

import BasicSimulatorDevice

c6328eb

update combinations of test devices and backends

72163a6

update devices and backends in integration tests

75447df

update tests for incompatible devices and versions

0ee569b

update QiskitDevice tests to use IBMQ instead of BasicAer

714f263

tweak QiskitDevice for compatibility with BasicSimulator

7a9f31e

fix bad relative import path

8cae9f9

trbromley reviewed Mar 11, 2024

View reviewed changes

pennylane_qiskit/basic_aer.py Outdated Show resolved Hide resolved

pennylane_qiskit/basic_aer.py Show resolved Hide resolved

pennylane_qiskit/basic_aer.py Outdated Show resolved Hide resolved

lillian542 and others added 10 commits March 28, 2024 13:42

Merge branch 'master' into compatibility

9f36d27

skip devices in conftest with incompatible provider-backend combinations

ee4a0cd

qasm_simulator is just qasm_simulator for old qiskit too now

79a2880

more fixes for combinations of providers and backends

4d3996a

move import to top level

8435386

update to supported backends in test_qiskit_device.py

9989ad3

correct Regex pattern for error test

0065480

update providers and backends in test_integration.py

9032d2b

trigger ci

652adfb

use provider that doesn't requre token

3268f65

Alex-Preciado requested review from astralcai and removed request for PietropaoloFrisoni and jay-selby April 3, 2024 15:55

mudit2812 reviewed Apr 3, 2024

View reviewed changes

.github/workflows/tests_qiskit_1.yml Show resolved Hide resolved

mudit2812 approved these changes Apr 3, 2024

View reviewed changes

trbromley reviewed Apr 3, 2024

View reviewed changes

lillian542 and others added 12 commits April 3, 2024 16:18

Apply suggestions from code review

bfcd346

Co-authored-by: Thomas R. Bromley <[email protected]>

rearrange order of device cards on docs page

fe0dc6d

docs updates

c75ef36

Update doc/devices/basicsim.rst

36855c0

Co-authored-by: Thomas R. Bromley <[email protected]>

add reference

3058267

correct reference

655166a

maybe it doesn't like underscores?

e6a9180

update reference

ec65874

update refs

0125bab

add custom analytic not supported msg for BasicProvider device

e1664eb

update warning

094afba

remove unused import

05735df

astralcai approved these changes Apr 5, 2024

View reviewed changes

lillian542 requested a review from trbromley April 9, 2024 18:53

trbromley approved these changes Apr 9, 2024

View reviewed changes

lillian542 and others added 6 commits April 10, 2024 09:59

remove kwarg section of basic_simulator docstring

1db98aa

trigger ci

e0f8af5

Unpin Qiskit where relevant (#508)

647d64c

* update to use requirements-ci and requirements-ci-legacy * unpin qiskit-ibm-runtime * add explicit qiskit-ibm-runtime requirement * unpin in upload yaml * update changelog

Merge branch 'master' into compatibility

ef9c832

add codecov token for 1.0 tests

1feb916

add codecov token for 1.0 tests one more place

ec9bae5

lillian542 merged commit e3f9482 into master Apr 10, 2024
14 checks passed

lillian542 deleted the compatibility branch April 10, 2024 21:28

JMuff22 mentioned this pull request Apr 16, 2024

Support b.num_qubits for BackendV2 Qiskit objects #332

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Compatibility with 1.0 for devices #493

Compatibility with 1.0 for devices #493

lillian542 commented Mar 8, 2024 •

edited

Loading

lillian542 commented Mar 8, 2024

lillian542 commented Mar 8, 2024

codecov bot commented Apr 1, 2024 •

edited

Loading

mudit2812 left a comment

trbromley left a comment

trbromley Apr 3, 2024

lillian542 Apr 3, 2024

trbromley Apr 9, 2024

trbromley Apr 3, 2024

lillian542 Apr 3, 2024

lillian542 Apr 3, 2024

trbromley Apr 9, 2024

astralcai left a comment

trbromley left a comment

trbromley Apr 9, 2024

trbromley Apr 9, 2024

lillian542 Apr 10, 2024

trbromley Apr 9, 2024

trbromley Apr 9, 2024

		By default, tests on the ``ibmq`` device run with ``ibmq_qasm_simulator`` backend. At
		the time of writing this means that the test are "free".

Compatibility with 1.0 for devices #493

Compatibility with 1.0 for devices #493

Conversation

lillian542 commented Mar 8, 2024 • edited Loading

lillian542 commented Mar 8, 2024

lillian542 commented Mar 8, 2024

codecov bot commented Apr 1, 2024 • edited Loading

Codecov Report

mudit2812 left a comment

Choose a reason for hiding this comment

trbromley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

astralcai left a comment

Choose a reason for hiding this comment

trbromley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lillian542 commented Mar 8, 2024 •

edited

Loading

codecov bot commented Apr 1, 2024 •

edited

Loading