Skip to content
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

Merged
merged 5 commits into from
Aug 30, 2023
Merged

Conversation

timmysilv
Copy link
Contributor

@timmysilv timmysilv commented Aug 29, 2023

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 the qml.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

@codecov
Copy link

codecov bot commented Aug 29, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (2e3c671) 99.66% compared to head (cf5d91c) 99.66%.

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           
Files Changed Coverage Δ
pennylane/devices/__init__.py 100.00% <ø> (ø)
pennylane/devices/qubit/__init__.py 100.00% <ø> (ø)
pennylane/devices/qubit/adjoint_jacobian.py 100.00% <ø> (ø)
pennylane/devices/qubit/apply_operation.py 100.00% <ø> (ø)
pennylane/devices/qubit/preprocess.py 100.00% <ø> (ø)
pennylane/devices/qubit/sampling.py 100.00% <ø> (ø)
pennylane/devices/qubit/simulate.py 100.00% <ø> (ø)

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

@timmysilv timmysilv marked this pull request as ready for review August 30, 2023 14:22
@timmysilv timmysilv requested a review from a team August 30, 2023 14:22
doc/releases/changelog-dev.md Show resolved Hide resolved
Copy link
Contributor

@albi3ro albi3ro left a 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?

@timmysilv timmysilv enabled auto-merge (squash) August 30, 2023 18:50
@timmysilv timmysilv merged commit 35467ce into master Aug 30, 2023
38 checks passed
@timmysilv timmysilv deleted the devices-qubit-docs branch August 30, 2023 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants