Deprecate `tape` and `qtape` properties on the `QNode` #6583

andrijapau · 2024-11-13T19:28:25Z

Context:

The QNode currently has QNode.tape and QNode.qtape properties, which track the last tape generated during a construct call. Users can check these to verify what was executed most recently.

Now, we’ve added construct_tape(qnode)(*args, **kwargs) in the workflow module as a preferred method for constructing tapes. This function creates a tape without modifying the QNode, ensuring it doesn’t interfere with other parts of the codebase.

Description of the change

Hopefully removed all calls to QNode.tape and QNode.qtape in the PennyLane source code.
Since many tests rely on these properties to access tape information, I’ve temporarily suppressed the warnings. This needs to be revisited in the backlog and gradually updated to use the preferred code [sc-78317].

Found references in,

No references in,

Lightning
Catalyst
AQT
IONQ
Qulacs
Cirq

Benefits: Removes problems and confusion with having a mutable tape property.

Possible Drawbacks: None

[sc-76836]

… them

codecov · 2024-11-13T23:11:04Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.45%. Comparing base (8df1025) to head (8d421d2).
Report is 311 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6583   +/-   ##
=======================================
  Coverage   99.44%   99.45%           
=======================================
  Files         450      450           
  Lines       42088    42088           
=======================================
+ Hits        41856    41857    +1     
+ Misses        232      231    -1

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

pennylane/debugging/snapshot.py

pennylane/fourier/qnode_spectrum.py

pennylane/gradients/classical_jacobian.py

pennylane/gradients/parameter_shift_hessian.py

pennylane/math/multi_dispatch.py

pennylane/optimize/qnspsa.py

pennylane/optimize/shot_adaptive.py

pennylane/transforms/core/transform_program.py

Co-authored-by: Christina Lee <christina@xanadu.ai>

tests/test_qnode.py

Co-authored-by: Christina Lee <christina@xanadu.ai>

…1266) Summary: Updating deprecated code that was introduced from a recent deprecation PennyLaneAI/pennylane#6583. [sc-76836]

albi3ro

❤️

doc/releases/changelog-dev.md

Co-authored-by: Mudit Pandey <mudit.pandey@xanadu.ai>

mudit2812

Looks good. There are a couple of comments that are blocking approval from me.

pennylane/workflow/qnode.py

tests/test_qnode_legacy.py

tests/circuit_graph/test_circuit_graph.py

Co-authored-by: Mudit Pandey <mudit.pandey@xanadu.ai>

…nnylane into deprecate-tape-properties

**Context:** Many tests incorrectly rely on the `tape` and `qtape` properties to access information during tests. With these properties deprecated in #6583, deprecation warnings in the affected test files have been suppressed. This PR aims to replace all instances of deprecated code with the correct code. **Description of the Change:** Tests should construct the tape dynamically using `construct_tape` rather than use the deprecated properties. **Benefits:** Better testing and code maintainability. **Possible Drawbacks:** I’m still a bit unsure about the changes in tests/workflow/interfaces/qnode/. The lines I deleted were originally a workaround to further verify QNode interfacing. However, the primary goal of the tests in this folder isn’t to check gradient accuracy but rather to ensure proper interfacing with the QNode architecture (e.g., verifying data types and result shapes). Since the property being used should now be considered private, relying on it in tests isn’t best practice—hence the deletion. [sc-78317] --------- Co-authored-by: Pietropaolo Frisoni <pietropaolo.frisoni@xanadu.ai>

initial deprecations

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

ca420b5

andrijapau marked this pull request as ready for review November 13, 2024 19:28

andrijapau and others added 6 commits November 13, 2024 14:29

update changelog

0de5a26

remove tape/qtape from source code and put warnings on tests that use…

7eec801

… them

Merge branch 'master' into deprecate-tape-properties

7201df2

change construct_tape level

342e5f0

change construct_tape level and typo

c851e7e

fix qnspsa

7392ad9

fix code cov, this branch is never hit

2e36047

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/debugging/snapshot.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/fourier/qnode_spectrum.py Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/gradients/classical_jacobian.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/gradients/parameter_shift_hessian.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/math/multi_dispatch.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/optimize/qnspsa.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/optimize/qnspsa.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/optimize/qnspsa.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/optimize/qnspsa.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/optimize/qnspsa.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/optimize/shot_adaptive.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/transforms/core/transform_program.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

pennylane/transforms/core/transform_program.py Outdated Show resolved Hide resolved

andrijapau and others added 7 commits November 14, 2024 11:53

Update pennylane/debugging/snapshot.py

d082e89

Co-authored-by: Christina Lee <christina@xanadu.ai>

Update pennylane/gradients/classical_jacobian.py

1557c29

Co-authored-by: Christina Lee <christina@xanadu.ai>

Update pennylane/gradients/parameter_shift_hessian.py

4b5f391

Co-authored-by: Christina Lee <christina@xanadu.ai>

Update pennylane/math/multi_dispatch.py

2903c29

Co-authored-by: Christina Lee <christina@xanadu.ai>

Update pennylane/optimize/qnspsa.py

2dd682d

Co-authored-by: Christina Lee <christina@xanadu.ai>

Update pennylane/optimize/qnspsa.py

e68955c

Co-authored-by: Christina Lee <christina@xanadu.ai>

Update pennylane/optimize/qnspsa.py

5704fe8

Co-authored-by: Christina Lee <christina@xanadu.ai>

albi3ro reviewed Nov 14, 2024

View reviewed changes

tests/test_qnode.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

tests/test_qnode.py Outdated Show resolved Hide resolved

albi3ro reviewed Nov 14, 2024

View reviewed changes

tests/test_qnode.py Outdated Show resolved Hide resolved

andrijapau and others added 3 commits November 14, 2024 16:25

Merge branch 'master' into deprecate-tape-properties

1c0fa80

Update tests/test_qnode.py

82bf23d

Co-authored-by: Christina Lee <christina@xanadu.ai>

address Christina's comments

85bfe4c

andrijapau requested a review from albi3ro November 14, 2024 21:34

albi3ro approved these changes Nov 15, 2024

View reviewed changes

mudit2812 reviewed Nov 15, 2024

View reviewed changes

doc/releases/changelog-dev.md Outdated Show resolved Hide resolved

Update doc/releases/changelog-dev.md

28b4c30

Co-authored-by: Mudit Pandey <mudit.pandey@xanadu.ai>

mudit2812 reviewed Nov 15, 2024

View reviewed changes

pennylane/workflow/qnode.py Outdated Show resolved Hide resolved

tests/test_qnode_legacy.py Outdated Show resolved Hide resolved

tests/circuit_graph/test_circuit_graph.py Show resolved Hide resolved

Update pennylane/workflow/qnode.py

5dd7e4b

Co-authored-by: Mudit Pandey <mudit.pandey@xanadu.ai>

andrijapau requested a review from mudit2812 November 18, 2024 15:03

andrijapau added 2 commits November 18, 2024 10:17

Merge branch 'master' into deprecate-tape-properties

354505e

run black

f15aa35

mudit2812 approved these changes Nov 18, 2024

View reviewed changes

andrijapau and others added 5 commits November 18, 2024 11:08

Merge branch 'master' into deprecate-tape-properties

2740d25

return to default.mixed

f1d6793

return to default.mixed

c8d1dda

Merge branch 'deprecate-tape-properties' of github.com:PennyLaneAI/pe…

088d6ec

…nnylane into deprecate-tape-properties

Merge branch 'master' into deprecate-tape-properties

8d421d2

andrijapau enabled auto-merge (squash) November 18, 2024 18:11

andrijapau disabled auto-merge November 18, 2024 18:25

andrijapau merged commit 9a3dbdd into master Nov 18, 2024
46 checks passed

andrijapau deleted the deprecate-tape-properties branch November 18, 2024 19:51

andrijapau mentioned this pull request Dec 3, 2024

Update deprecated QNode.(q)tape property usage in tests #6625

Merged

eliasKA mentioned this pull request Jan 31, 2025

[QI2-1292] Add cQASM export to Pennylane plugin QuTech-Delft/pennylane-quantuminspire2#72

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `tape` and `qtape` properties on the `QNode` #6583

Deprecate `tape` and `qtape` properties on the `QNode` #6583

andrijapau commented Nov 13, 2024 •

edited

Loading

codecov bot commented Nov 13, 2024 •

edited

Loading

albi3ro left a comment

mudit2812 left a comment

Deprecate tape and qtape properties on the QNode #6583

Deprecate tape and qtape properties on the QNode #6583

Conversation

andrijapau commented Nov 13, 2024 • edited Loading

codecov bot commented Nov 13, 2024 • edited Loading

Codecov Report

albi3ro left a comment

Choose a reason for hiding this comment

mudit2812 left a comment

Choose a reason for hiding this comment

Deprecate `tape` and `qtape` properties on the `QNode` #6583

Deprecate `tape` and `qtape` properties on the `QNode` #6583

andrijapau commented Nov 13, 2024 •

edited

Loading

codecov bot commented Nov 13, 2024 •

edited

Loading