-
Notifications
You must be signed in to change notification settings - Fork 586
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update the developers plugin guide to use QubitDevice #483
Conversation
Codecov Report
@@ Coverage Diff @@
## master #483 +/- ##
======================================
Coverage 99.1% 99.1%
======================================
Files 51 51
Lines 3910 3910
======================================
Hits 3875 3875
Misses 35 35 Continue to review full report at Codecov.
|
…nnylane into actually-update-plugin-guide
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome Josh, I haven't had much to do with plugin development but now I feel I could do it myself!
Two general things you may want to improve:
- The "Device execution" section is still rather dense. Maybe use a few more sentences/examples to explain, since people also use different technical terms sometimes?
- It is a bit confusing that there are CV/Qubit devices, then the QubitDevice is used throughout the explanation, and at the end there is a CVOperation. I think it's fine to focus on QubitDevice, but it should be clear how CV is different from that?
This was (unfortunately) deliberate 🙁 My thinking was:
What do you think is the least confusing approach? Once the Options are:
|
Co-Authored-By: Maria Schuld <mariaschuld@gmail.com>
…nnylane into actually-update-plugin-guide
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left one comment about adding Identity
to the set of observables
Codecov Report
@@ Coverage Diff @@
## master #483 +/- ##
=======================================
Coverage 99.05% 99.05%
=======================================
Files 51 51
Lines 3923 3923
=======================================
Hits 3886 3886
Misses 37 37
Continue to review full report at Codecov.
|
…nnylane into actually-update-plugin-guide
doc/development/plugins.rst
Outdated
class is deprecated, and a new** ``CVDevice`` **class will be available in the next major | ||
PennyLane release.** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better: will be available soon? I learnt to not promise things if not absolutely necessary :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for making the changes, approved from my side.
Context: The new
QubitDevice
makes plugin development significantly easier. The existingDevice
API should be considered deprecated, and will eventually be removed fromDevice
.Description of the Change:
Updates the plugin guide to focus on the new plugin API
Cleans up some docstrings in
QubitDevice
Benefits: n/a
Possible Drawbacks:
Some plugins currently still use
Device
; they will need to be ported toQubitDevice
.A
CVDevice
equivalent is still TODO.Related GitHub Issues: n/a