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

Update transforms documentation #4682

Merged

Conversation

trbromley
Copy link
Contributor

@trbromley trbromley commented Oct 16, 2023

Description of the Change:

  • qml.transforms.core.transform is now top level qml.transform
  • Update qml.transforms page
  • Update the documentation for qml.transforms.core.transform
  • Update thar args and returns of all transform using qml.transforms.core.transform

@github-actions
Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@mudit2812 mudit2812 added this to the v0.33 milestone Oct 17, 2023
@codecov
Copy link

codecov bot commented Oct 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5cd8354) 99.64% compared to head (c411ca5) 99.64%.
Report is 4 commits behind head on 0.33-doc-fixes.

Additional details and impacted files
@@                Coverage Diff                 @@
##           0.33-doc-fixes    #4682      +/-   ##
==================================================
- Coverage           99.64%   99.64%   -0.01%     
==================================================
  Files                 380      380              
  Lines               34245    34000     -245     
==================================================
- Hits                34124    33878     -246     
- Misses                121      122       +1     
Files Coverage Δ
pennylane/__init__.py 100.00% <ø> (ø)
pennylane/devices/device_api.py 98.57% <ø> (-0.03%) ⬇️
pennylane/devices/preprocess.py 100.00% <100.00%> (ø)
pennylane/fourier/circuit_spectrum.py 100.00% <100.00%> (ø)
pennylane/gradients/__init__.py 100.00% <ø> (ø)
pennylane/gradients/finite_difference.py 100.00% <100.00%> (ø)
pennylane/gradients/hadamard_gradient.py 100.00% <100.00%> (ø)
pennylane/gradients/parameter_shift.py 100.00% <100.00%> (ø)
pennylane/gradients/parameter_shift_cv.py 99.62% <100.00%> (ø)
pennylane/gradients/parameter_shift_hessian.py 100.00% <ø> (ø)
... and 43 more

... and 39 files with indirect coverage changes

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

Copy link
Contributor

@timmysilv timmysilv left a comment

Choose a reason for hiding this comment

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

nothing more from me, thanks for getting through all of this!

pennylane/transforms/core/transform_dispatcher.py Outdated Show resolved Hide resolved
pennylane/qnode.py Outdated Show resolved Hide resolved
pennylane/transforms/__init__.py Outdated Show resolved Hide resolved
pennylane/transforms/__init__.py Outdated Show resolved Hide resolved
Copy link
Contributor Author

@trbromley trbromley left a comment

Choose a reason for hiding this comment

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

Thanks @rmoyard! I still need to look through transform, transform_dispatcher and transform_program (will do that this afternoon).

For now I'll leave my comments from looking through carefully at the transform docs.

My main nontrivial comments are around some replication of the examples - happy to discuss this.

Thanks again for this effort!

pennylane/gradients/parameter_shift_hessian.py Outdated Show resolved Hide resolved
pennylane/ops/functions/eigvals.py Outdated Show resolved Hide resolved
pennylane/ops/functions/map_wires.py Outdated Show resolved Hide resolved
pennylane/ops/functions/matrix.py Outdated Show resolved Hide resolved
pennylane/qnode.py Show resolved Hide resolved
pennylane/transforms/mitigate.py Outdated Show resolved Hide resolved
pennylane/transforms/optimization/commute_controlled.py Outdated Show resolved Hide resolved
pennylane/transforms/optimization/pattern_matching.py Outdated Show resolved Hide resolved
pennylane/transforms/optimization/pattern_matching.py Outdated Show resolved Hide resolved
pennylane/transforms/zx/converter.py Outdated Show resolved Hide resolved
@trbromley trbromley requested a review from rmoyard October 27, 2023 17:54
Copy link
Contributor

@rmoyard rmoyard left a comment

Choose a reason for hiding this comment

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

💯

pennylane/transforms/__init__.py Outdated Show resolved Hide resolved
pennylane/transforms/core/transform.py Outdated Show resolved Hide resolved
pennylane/transforms/core/transform.py Outdated Show resolved Hide resolved
pennylane/transforms/core/transform.py Outdated Show resolved Hide resolved
@trbromley trbromley merged commit c3b6518 into 0.33-doc-fixes Oct 27, 2023
29 checks passed
@trbromley trbromley deleted the sc-38900-the-transform-module-docstrings-are-improved branch October 27, 2023 20:07
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.

6 participants