PennyLaneAI / pennylane-qiskit

The PennyLane-Qiskit plugin integrates the Qiskit quantum computing framework and IBM Q with PennyLane.
https://docs.pennylane.ai/projects/qiskit
Apache License 2.0
194 stars 66 forks source link

Plugin page update #563

Closed austingmhuang closed 4 months ago

austingmhuang commented 5 months ago

Context The plugin page is outdated.

Changes Update the plugin page to fix the broken links and also to match what the plugin currently supports. Some of the demos/tutorial have been removed as well.

Notes We could add some new tutorials/how-tos on how to use the plugin so that this page is more informative. I think it is a good idea but not sure if it belongs in this PR.

austingmhuang commented 5 months ago

[sc-54395]

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (b6c3989) to head (957cee8).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## new_device_feature_branch #563 +/- ## =========================================================== Coverage 100.00% 100.00% =========================================================== Files 8 8 Lines 796 796 =========================================================== Hits 796 796 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

austingmhuang commented 4 months ago

Should we consider a warning in the installation guide reminding users not to install the plugin in an environment with an existing installation of Qiskit<1.0?

Yes I think this is a good idea. Actually I thought I wrote a warning about this somewhere but maybe I deleted it...

austingmhuang commented 4 months ago

The "Backends" section on this page also feels outdated - it includes passing a string backend, which is only relevant for the Aer device now. It also claims that PennyLane chooses the aer_simulator as the default backend if none is specified, which is now only true for the Aer device.

I was thinking about making this a section that makes clear that Aer and Remote are different devices and that Aer can take in a string while Remote does not. But perhaps there should also be a deprecation warning that lets users know that setting backends via string is going to be deprecated soon? I think that would be a better "Backend" section, but I'm not 100% sure. What do you think?