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

DocFix: computing qml.jacobian for multiple measurement outcomes #6283

Merged
merged 7 commits into from
Sep 30, 2024

Conversation

PietropaoloFrisoni
Copy link
Contributor

@PietropaoloFrisoni PietropaoloFrisoni commented Sep 19, 2024

Context: The documentation for qml.jacobian seems quite old and contains several examples that should be updated.

Description of the Change: We updated the examples according to the meaning in the documentation. For instance, one example stated that the provided circuit outputs the probability for each basis state, while it was actually computing the expectation values of an operator.

Benefits: Better documentation with working examples.

Possible Drawbacks: None that I can think of.

Related GitHub Issues: #6259

Related Shortcut Stories: [sc-73557]

@PietropaoloFrisoni PietropaoloFrisoni changed the title [Bugfix]: computing qml.jacobian for multiple measurement outcomes BUGFIX: computing qml.jacobian for multiple measurement outcomes Sep 19, 2024
@PietropaoloFrisoni PietropaoloFrisoni marked this pull request as ready for review September 30, 2024 13:05
Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.70%. Comparing base (215ab98) to head (9e5f199).
Report is 353 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6283   +/-   ##
=======================================
  Coverage   99.70%   99.70%           
=======================================
  Files         444      444           
  Lines       42223    42223           
=======================================
  Hits        42100    42100           
  Misses        123      123           

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

Copy link
Contributor

@dwierichs dwierichs left a comment

Choose a reason for hiding this comment

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

Nice fix, thanks @PietropaoloFrisoni 🎉

You could consider updating the PR title for future reference: It is a documentation upgrade and not a bug fix, right?

@PietropaoloFrisoni PietropaoloFrisoni changed the title BUGFIX: computing qml.jacobian for multiple measurement outcomes DocFix: computing qml.jacobian for multiple measurement outcomes Sep 30, 2024
@PietropaoloFrisoni PietropaoloFrisoni merged commit be676fe into master Sep 30, 2024
43 checks passed
@PietropaoloFrisoni PietropaoloFrisoni deleted the bugfix_jacobian_multiple_measurements branch September 30, 2024 13:40
PietropaoloFrisoni added a commit that referenced this pull request Oct 2, 2024
**Context:** While we use `from pennylane import numpy as pnp`
internally in the code base, we should not use it for user-facing
documentation. The current convention is:

```
from pennylane import numpy as np
```

**Description of the Change:** We revert the changes to the
documentation introduced in #6283 and #6303 that violate such a
principle.

**Benefits:** Consistent convention across the documentation.

**Possible Drawbacks:** None that I can think of

**Related GitHub Issues:** None

**Related Shortcut Stories:** [sc-74716]

---------

Co-authored-by: dwierichs <david.wierichs@xanadu.ai>
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