Wrapping of legacy device automatically in various device creation/qnode/execute functions #6046

Shiro-Raven · 2024-07-26T19:24:02Z

Context:
With the LegacyDeviceFacade now in place, we can add automatic wrapping of legacy devices.

Description of the Change:
Add automatic wrapping to qml.device, qml.execute, QNode constructor, and the get_best_method and best_method_str functions of the QNode class. The tests are also updated accordingly.

Benefits:
Users no longer need to worry about upgrading their devices to the new Device API and can use the facade to access the basic functions of the new API.

Possible Drawbacks:
The facade doesn't yet provide all potential advantages of fully upgrading to the new API

[sc-65998]

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

…LaneAI/pennylane into legacy-device-facade-class

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

pennylane/devices/legacy_facade.py

pennylane/devices/tests/conftest.py

pennylane/devices/tests/test_measurements.py

pennylane/transforms/core/transform_dispatcher.py

pennylane/workflow/execution.py

pennylane/workflow/qnode.py

…a device, addressed more codecov issues

astralcai

LGTM! Impressive work! 🚀

pennylane/devices/legacy_facade.py

mudit2812

Finally getting this across the finish line! Thanks for the changes and for the dev comments.

albi3ro

Fantastic job on a rather difficult piece of work. I am excited to have finally reached this threshold in a very, very long process. This is going to make development of the workflow much easier going forward, and unlock a lot of technical improvements and code quality possibilities.

…ots (#839) **Context:** PR PennyLaneAI/pennylane#6046 wraps the legacy device API automatically in various device creation, qnode, and execute functions. As LK and LGPU plugins still rely on the legacy device API, the shots tests and the `generate_samples` logic in `lightning_kokkos.py` and `lightning_gpu.py` should be updated to adhere the new convention. **Related Shortcut Stories:** [sc-65998] --------- Co-authored-by: ringo-but-quantum <github-ringo-but-quantum@xanadu.ai> Co-authored-by: Shiro-Raven <exclass9.24@gmail.com> Co-authored-by: albi3ro <chrissie.c.l@gmail.com>

…legacy device for MPI LGPU (#864) ### Before submitting Please complete the following checklist when submitting a PR: - [x] All new features must include a unit test. If you've fixed a bug or added code that should be tested, add a test to the [`tests`](../tests) directory! - [x] All new functions and code must be clearly commented and documented. If you do make documentation changes, make sure that the docs build and render correctly by running `make docs`. - [x] Ensure that the test suite passes, by running `make test`. - [x] Add a new entry to the `.github/CHANGELOG.md` file, summarizing the change, and including a link back to the PR. - [x] Ensure that code is properly formatted by running `make format`. When all the above are checked, delete everything above the dashed line and fill in the pull request template. ------------------------------------------------------------------------------------------------------------ **Context:** - PR PennyLaneAI/pennylane#6021 removed code duplication for `BasisEmbedding` and `BasisState`. As the result `BasisState` no longer decomposes to `BasisStatePreparation`. This PR updates Python unit tests to support this generalization of basis state preparation. - PR PennyLaneAI/pennylane#6046 added a facade wrapper class for "legacy" devices. This PR is a follow up to PR #839 updating Multi-GPU LGPU device and tests. **Description of the Change:** **Benefits:** **Possible Drawbacks:** **Related GitHub Issues:** --------- Co-authored-by: ringo-but-quantum <github-ringo-but-quantum@xanadu.ai>

…acade (#1035) **Context:** This PR is to fix an issue that will be caused after merging the following PR: PennyLaneAI/pennylane#6046 The problem is that LegacyDeviceFacade will cause the Legacy Devices to use the Shots class instead of an integer which causes a crash in runtime. **Description of the Change:** This PR ensures that the any device that is an instance of the new device API uses the shots class to extract the total number of shots. **Related GitHub Issues:** [sc-70792] --------- Co-authored-by: Ahmed Darwish <exclass9.24@gmail.com>

…ots (#839) **Context:** PR PennyLaneAI/pennylane#6046 wraps the legacy device API automatically in various device creation, qnode, and execute functions. As LK and LGPU plugins still rely on the legacy device API, the shots tests and the `generate_samples` logic in `lightning_kokkos.py` and `lightning_gpu.py` should be updated to adhere the new convention. **Related Shortcut Stories:** [sc-65998] --------- Co-authored-by: ringo-but-quantum <github-ringo-but-quantum@xanadu.ai> Co-authored-by: Shiro-Raven <exclass9.24@gmail.com> Co-authored-by: albi3ro <chrissie.c.l@gmail.com>

…legacy device for MPI LGPU (#864) ### Before submitting Please complete the following checklist when submitting a PR: - [x] All new features must include a unit test. If you've fixed a bug or added code that should be tested, add a test to the [`tests`](../tests) directory! - [x] All new functions and code must be clearly commented and documented. If you do make documentation changes, make sure that the docs build and render correctly by running `make docs`. - [x] Ensure that the test suite passes, by running `make test`. - [x] Add a new entry to the `.github/CHANGELOG.md` file, summarizing the change, and including a link back to the PR. - [x] Ensure that code is properly formatted by running `make format`. When all the above are checked, delete everything above the dashed line and fill in the pull request template. ------------------------------------------------------------------------------------------------------------ **Context:** - PR PennyLaneAI/pennylane#6021 removed code duplication for `BasisEmbedding` and `BasisState`. As the result `BasisState` no longer decomposes to `BasisStatePreparation`. This PR updates Python unit tests to support this generalization of basis state preparation. - PR PennyLaneAI/pennylane#6046 added a facade wrapper class for "legacy" devices. This PR is a follow up to PR #839 updating Multi-GPU LGPU device and tests. **Description of the Change:** **Benefits:** **Possible Drawbacks:** **Related GitHub Issues:** --------- Co-authored-by: ringo-but-quantum <github-ringo-but-quantum@xanadu.ai>

…ode/execute functions (#6046) **Context:** With the `LegacyDeviceFacade` now in place, we can add automatic wrapping of legacy devices. **Description of the Change:** Add automatic wrapping to `qml.device`, `qml.execute`, `QNode` constructor, and the `get_best_method` and `best_method_str` functions of the QNode class. The tests are also updated accordingly. **Benefits:** Users no longer need to worry about upgrading their devices to the new Device API and can use the facade to access the basic functions of the new API. **Possible Drawbacks:** The facade doesn't yet provide all potential advantages of fully upgrading to the new API [[sc-65998](https://app.shortcut.com/xanaduai/story/65998)] --------- Co-authored-by: albi3ro <chrissie.c.l@gmail.com> Co-authored-by: Christina Lee <christina@xanadu.ai> Co-authored-by: Mudit Pandey <mudit.pandey@xanadu.ai> Co-authored-by: ringo-but-quantum <github-ringo-but-quantum@xanadu.ai> Co-authored-by: David Wierichs <david.wierichs@xanadu.ai> Co-authored-by: Thomas R. Bromley <49409390+trbromley@users.noreply.github.com> Co-authored-by: Korbinian Kottmann <43949391+Qottmann@users.noreply.github.com>

albi3ro and others added 30 commits April 1, 2024 16:50

adding legacydevicefacade class

ab601c8

more tests

b6daa90

adding to interfaces tests

7b20c99

finish up torch tests

71db075

merge master

2e17b76

fixing up interface tests

583f526

starting on testing

34e0856

starting on testing

6f12302

Merge branch 'master' into legacy-device-facade-class

d32f7f9

fixing up tests

900fa35

adding some more test coverage [skip-ci]

0771623

adding some more tests and coverage

4dbd068

more tests and some docs

bb6612e

Merge branch 'master' into legacy-device-facade-class

f998016

Merge branch 'master' into legacy-device-facade-class

cf46f57

pass along postselect mode

f654249

Merge branch 'master' into legacy-device-facade-class

4e9cc8d

Update pennylane/devices/legacy_facade.py

9b7605a

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

resolving merges

ebb8f44

Merge branch 'legacy-device-facade-class' of https://github.com/Penny…

30029db

…LaneAI/pennylane into legacy-device-facade-class

revert merge problems

0d11cd2

Update pennylane/devices/legacy_facade.py

0021a54

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

Update tests/devices/test_legacy_facade.py

7f2e199

Merge branch 'master' into legacy-device-facade-class

0c7f247

deprecation of backprop device switching

64e59f7

Update pennylane/devices/legacy_facade.py

a3d0032

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

added facade wrappers, some tests still failing

2c2a764

Merge branch 'legacy-device-facade-class' into ad/facade-wrapper

d71419f

Merge branch 'master' into ad/facade-wrapper

f6b7a52

more test fixes and renaming of dq2 test file

c49a816

Shiro-Raven added 2 commits August 14, 2024 11:17

Merge branch 'master' into ad/facade-wrapper

e1cfde3

more codecov fixes and minor code movement

8720103

astralcai reviewed Aug 14, 2024

View reviewed changes

Shiro-Raven added 3 commits August 14, 2024 13:54

Merge branch 'master' into ad/facade-wrapper

3df7558

remove __new__ method from facade class, added error for re-wrapping …

7a5085c

…a device, addressed more codecov issues

Merge branch 'master' into ad/facade-wrapper

8f75e51

astralcai approved these changes Aug 15, 2024

View reviewed changes

Shiro-Raven requested a review from mudit2812 August 16, 2024 14:22

mudit2812 reviewed Aug 16, 2024

View reviewed changes

pennylane/devices/legacy_facade.py Show resolved Hide resolved

mudit2812 approved these changes Aug 16, 2024

View reviewed changes

Shiro-Raven requested a review from albi3ro August 16, 2024 16:22

maliasadi mentioned this pull request Aug 16, 2024

Update generate_samples in LK and LGPU to support qml.measurements.Shots PennyLaneAI/pennylane-lightning#839

Merged

albi3ro approved these changes Aug 16, 2024

View reviewed changes

mehrdad2m mentioned this pull request Aug 19, 2024

fixed catalyst to correctly extract number of shots for legacyDeviceFacade PennyLaneAI/catalyst#1035

Merged

Shiro-Raven added 6 commits August 19, 2024 13:58

add copy operations to facade class for catalyst use case

7ed7a0b

Merge branch 'master' into ad/facade-wrapper

030715d

trigger CI

b99804c

Merge branch 'master' into ad/facade-wrapper

b59bb38

Merge branch 'master' into ad/facade-wrapper

d7e4438

Merge branch 'master' into ad/facade-wrapper

3a97f79

Shiro-Raven merged commit 1f55c88 into master Aug 21, 2024
40 checks passed

Shiro-Raven deleted the ad/facade-wrapper branch August 21, 2024 02:59

maliasadi mentioned this pull request Aug 22, 2024

Support the generalization of basis state preparation and the facade legacy device for MPI LGPU PennyLaneAI/pennylane-lightning#864

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Wrapping of legacy device automatically in various device creation/qnode/execute functions #6046

Wrapping of legacy device automatically in various device creation/qnode/execute functions #6046

Shiro-Raven commented Jul 26, 2024

astralcai left a comment

mudit2812 left a comment

albi3ro left a comment

Wrapping of legacy device automatically in various device creation/qnode/execute functions #6046

Wrapping of legacy device automatically in various device creation/qnode/execute functions #6046

Conversation

Shiro-Raven commented Jul 26, 2024

astralcai left a comment

Choose a reason for hiding this comment

mudit2812 left a comment

Choose a reason for hiding this comment

albi3ro left a comment

Choose a reason for hiding this comment