Correct batch transform signatures in documentation #1733
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #1733 +/- ##
=======================================
Coverage 99.21% 99.21%
=======================================
Files 204 204
Lines 15425 15433 +8
=======================================
+ Hits 15304 15312 +8
Misses 121 121
Continue to review full report at Codecov.
|
dwierichs
approved these changes
Oct 9, 2021
Comment on lines
+325
to
+327
| * The `qml.batch_transform` decorator is now ignored during Sphinx builds, allowing | ||
| the correct signature to display in the built documentation. | ||
| [(#1733)](https://github.com/PennyLaneAI/pennylane/pull/1733) |
There was a problem hiding this comment.
Could add a word of warning how the detection of a sphinx build is done technically, so that users can quickly identify in case they run into the (unlikely) case of SPHINX_BUILD="1" in their environment?
There was a problem hiding this comment.
@dwierichs good idea! I added a warning here: 881b453
| tape2 = tape.copy() | ||
| return [tape1, tape2], None | ||
|
|
||
| assert isinstance(my_transform, qml.batch_transform) |
There was a problem hiding this comment.
Very nice to test both cases!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context: Currently, batch transformations created with the
@qml.batch_transformdecorator do not show the correct signature in the docs:This is due to a drawback of
functools.wraps--- it only wraps the docstring, not the signature.Description of the Change: The
@qml.batch_decoratoris modified to simply return the input function, with no decoration, if it detects a Sphinx build (SPHINX_BUILD = "1").Benefits:
The correct signature is now shown in the docs:
Possible Drawbacks:
If a user for some reason has
SPHINX_BUILD = "1"in their environment, batch transforms will fail to work on QNodes. To help avoid this, a warning is raised in this situation.Related GitHub Issues: