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

[Docs] Update gradient/jacobian documentation #271

Merged
merged 4 commits into from Aug 31, 2023
Merged

Conversation

pengmai
Copy link
Contributor

@pengmai pengmai commented Aug 31, 2023

Context: This PR implements some documentation changes that follow up on #244, particularly this comment.

Description of the Change: Update the docstrings for grad and jacobian, rename "defer" to "auto"

@codecov
Copy link

codecov bot commented Aug 31, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (6b319bd) 99.31% compared to head (8e3db9e) 99.31%.
Report is 1 commits behind head on main.

❗ Current head 8e3db9e differs from pull request most recent head 1cd1103. Consider uploading reports for the commit 1cd1103 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #271   +/-   ##
=======================================
  Coverage   99.31%   99.31%           
=======================================
  Files          41       41           
  Lines        7131     7131           
  Branches      376      376           
=======================================
  Hits         7082     7082           
  Misses         27       27           
  Partials       22       22           
Files Changed Coverage Δ
frontend/catalyst/pennylane_extensions.py 99.14% <100.00%> (ø)

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

@dime10 dime10 added this to the v0.3 milestone Aug 31, 2023
@pengmai pengmai requested review from josh146 and dime10 August 31, 2023 17:41
@pengmai pengmai marked this pull request as ready for review August 31, 2023 17:42
Copy link
Collaborator

@dime10 dime10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks a lot for addressing these :)

frontend/catalyst/pennylane_extensions.py Outdated Show resolved Hide resolved
frontend/catalyst/pennylane_extensions.py Outdated Show resolved Hide resolved
pengmai and others added 2 commits August 31, 2023 14:00
Rename 'hybrid circuit' -> 'hybrid function' in docs

Co-authored-by: David Ittah <dime10@users.noreply.github.com>
@dime10 dime10 merged commit 33e71bb into main Aug 31, 2023
11 of 12 checks passed
@dime10 dime10 deleted the jmp/gradient-docs branch August 31, 2023 18:23
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.

None yet

2 participants