-
Notifications
You must be signed in to change notification settings - Fork 604
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
render docs for devices.qubit functions #4555
Conversation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #4555 +/- ##
=======================================
Coverage 99.66% 99.66%
=======================================
Files 376 376
Lines 33071 33071
=======================================
Hits 32961 32961
Misses 110 110
☔ View full report in Codecov by Sentry. |
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.
Could we add adjoint_jacobian
, adjoint_jvp
, and adjoint_vjp
to the table of contents as well?
I am open to notable variation in the docs here, just lmk! I mostly just wanted to get this PR going.
Context:
The
devices.qubit
functions are very useful, and people should be able to see them! They're still a little unstable, so I'm inclined to leave those warnings in the docs for now, but they should be visible.Description of the Change:
Add the
devices.qubit
qubit-simulation functions at the bottom of theqml.devices
sub-page in the "Internal" section (check it out here!)Benefits:
Nice pretty docs to show users all the cool features and helper functions we have
Possible Drawbacks:
It's still kinda unstable while we ramp up DQ2, but it should be ready by the time we release 0.33