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.30%. Comparing base (51c1436) to head (85bfe4c).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6583   +/-   ##
=======================================
  Coverage   99.29%   99.30%           
=======================================
  Files         454      454           
  Lines       43262    43262           
=======================================
+ Hits        42959    42960    +1     
+ Misses        303      302    -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 <[email protected]>

tests/test_qnode.py

Co-authored-by: Christina Lee <[email protected]>

…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 <[email protected]>

mudit2812

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

pennylane/workflow/qnode.py

mudit2812 · 2024-11-15T17:42:41Z

tests/test_qnode_legacy.py


    # pylint: disable=unexpected-keyword-arg
    def test_no_shots_per_call_if_user_has_shots_qfunc_arg(self):
        """Tests that the per-call shots overwriting is suspended
        if user has a shots argument, but a warning is raised."""
-        dev = qml.device("default.mixed", wires=[0, 1], shots=10)
+        dev = qml.device("default.qubit", wires=[0, 1], shots=10)


This file tests legacy devices, hence why default.mixed is used. Now that default.mixed is being ported over, we might need a different device. Maybe we should use the tests/default_qubit_legacy device? cc @albi3ro

tests/circuit_graph/test_circuit_graph.py

Co-authored-by: Mudit Pandey <[email protected]>

initial deprecations

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 <[email protected]>

Update pennylane/gradients/classical_jacobian.py

1557c29

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/gradients/parameter_shift_hessian.py

4b5f391

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/math/multi_dispatch.py

2903c29

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/optimize/qnspsa.py

2dd682d

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/optimize/qnspsa.py

e68955c

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/optimize/qnspsa.py

5704fe8

Co-authored-by: Christina Lee <[email protected]>

andrijapau and others added 6 commits November 14, 2024 11:54

Update pennylane/optimize/qnspsa.py

f76211d

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/optimize/qnspsa.py

878412b

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/optimize/shot_adaptive.py

1013125

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/transforms/core/transform_program.py

86bb030

Co-authored-by: Christina Lee <[email protected]>

Update pennylane/transforms/core/transform_program.py

7898e4b

Co-authored-by: Christina Lee <[email protected]>

Merge branch 'master' into deprecate-tape-properties

56d1c0a

andrijapau requested review from albi3ro and mudit2812 November 14, 2024 17:15

This was referenced Nov 14, 2024

Update deprecated usage of tape and qtape properties in QNode PennyLaneAI/qml#1266

Merged

Update deprecated usage of tape and qtape properties in QNode PennyLaneAI/pennylane-qiskit#602

Merged

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

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 <[email protected]>

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 <[email protected]>

mudit2812 reviewed Nov 15, 2024

View reviewed changes

Update pennylane/workflow/qnode.py

5dd7e4b

Co-authored-by: Mudit Pandey <[email protected]>

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

mudit2812 Nov 15, 2024

Deprecate tape and qtape properties on the QNode #6583

Are you sure you want to change the base?

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

mudit2812 Nov 15, 2024

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