Clarify difference between QuantumTape and QuantumScript
#5065
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
trbromley
approved these changes
Jan 15, 2024
albi3ro
commented
Jan 15, 2024
albi3ro
commented
Jan 15, 2024
Co-authored-by: Thomas R. Bromley <49409390+trbromley@users.noreply.github.com>
timmysilv
approved these changes
Jan 15, 2024
Co-authored-by: Matthew Silverman <matthews@xanadu.ai>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5065 +/- ##
==========================================
- Coverage 99.67% 99.66% -0.02%
==========================================
Files 394 394
Lines 35670 35395 -275
==========================================
- Hits 35554 35276 -278
- Misses 116 119 +3 ☔ View full report in Codecov by Sentry. |
mudit2812
pushed a commit
that referenced
this pull request
Jan 19, 2024
[sc-54022] **Context:** We keep the name `QuantumTape` in documentation, but strictly use its parent `QuantumScript` in PennyLane source code. We use `QuantumScript` because carrying around an unnecessary `AnnotatedQueue` can cause difficulties with parallelism and construction via queuing is substantially more expensive in both memory and time. Queuing can also lead to unintended side effects of things entering the circuit that shouldn't, or things not entering the circuit that should. This disconnect between documentation and source code is not explained anyone, and a bit confusing. So this adds some clarification to the module documentation for `qml.tape.`. **Description of the Change:** Added module documentation. **Benefits:** Hopefully this clears up some confusion. **Possible Drawbacks:** **Related GitHub Issues:** --------- Co-authored-by: Thomas R. Bromley <49409390+trbromley@users.noreply.github.com> Co-authored-by: Matthew Silverman <matthews@xanadu.ai>
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.
[sc-54022]
Context:
We keep the name
QuantumTapein documentation, but strictly use its parentQuantumScriptin PennyLane source code. We useQuantumScriptbecause carrying around an unnecessaryAnnotatedQueuecan cause difficulties with parallelism and construction via queuing is substantially more expensive in both memory and time. Queuing can also lead to unintended side effects of things entering the circuit that shouldn't, or things not entering the circuit that should.This disconnect between documentation and source code is not explained anyone, and a bit confusing. So this adds some clarification to the module documentation for
qml.tape..Description of the Change:
Added module documentation.
Benefits:
Hopefully this clears up some confusion.
Possible Drawbacks:
Related GitHub Issues: