Upgrade and generalise basis state preparation #6021

KetpuntoG · 2024-07-22T15:46:21Z

This PR complete part of this story: [sc-68521]

Goal: BasisEmbedding is an alias of BasisState. This way, we don't have duplicate code that does the same thing.
In unifying this, I have had to modify some tests due to:

BasisEmbedding and BasisState throw errors such as "incorrect length" with different messages. Now it will always be the same. (test modified for this reason: test_default_qubit_legacy.py, test_default_qubit_tf.py
test_default_qubit_torch.py, test_state_prep.py, test_all_singles_doubles.py and test_uccsd`)
In BasisEmbedding, errors were thrown in __init__ while in BasisState in state_vector. Now they are unified in __init__. For this reason, there were tests where the operator was not initialized correctly but no error was thrown since state_vector was not being called but now they are detected. To correct this, I have modified the tests: test_qscript.py, test_state_prep.py,
Now BasisState does not decompose BasisStatePreparation since we are going to deprecate it. This causes the number of gates after expanding to be affected. In this case I had to modify some test in test_tape.py.

This PR also solves:

Related Shortcut Stories:
[sc-69103]

github-actions · 2024-07-22T15:46:41Z

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

A one-to-two sentence description of the change. You may include a small working example for new features.
A link back to this PR.
Your name (or GitHub username) in the contributors section.

isaacdevlugt · 2024-07-22T21:10:19Z

Just making a note here that the failed SPSA test is fixed with this PR: #6027

KetpuntoG · 2024-07-23T08:07:19Z

[sc-68521]

codecov · 2024-07-23T11:03:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.65%. Comparing base (1f55c88) to head (e78efb4).
Report is 9 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6021      +/-   ##
==========================================
- Coverage   99.67%   99.65%   -0.02%     
==========================================
  Files         432      432              
  Lines       41839    41680     -159     
==========================================
- Hits        41702    41536     -166     
- Misses        137      144       +7

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

pennylane/templates/embeddings/basis.py

[skip-ci]

doc/development/deprecations.rst

pennylane/ops/qubit/state_preparation.py

doc/releases/changelog-dev.md

pennylane/ops/qubit/state_preparation.py

tests/ops/qubit/test_state_prep.py

…nylane into clean_state_prep

soranjh

Thanks @KetpuntoG , looks good to go.

doc/releases/changelog-dev.md

obliviateandsurrender

A couple of final minor comments, but looks good otherwise.

pennylane/ops/qubit/state_preparation.py

Co-authored-by: soranjh <40344468+soranjh@users.noreply.github.com> Co-authored-by: Utkarsh <utkarshazad98@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>

…ases (PennyLaneAI/pennylane#6021). We update our tests to agree with them.

**Context:** PL recently changed error messages for bad stateprep/basisstate use cases (PennyLaneAI/pennylane#6021). We update our tests to agree with them. **Benefits:** Frontend tests `test_skip_initial_stateprep/TestPossibleErrors` can pass

…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>

This PR complete part of this story: [[sc-68521](https://app.shortcut.com/xanaduai/story/68521)] Goal: `BasisEmbedding` is an alias of `BasisState`. This way, we don't have duplicate code that does the same thing. In unifying this, I have had to modify some tests due to: - `BasisEmbedding` and `BasisState` throw errors such as "incorrect length" with different messages. Now it will always be the same. (test modified for this reason: `test_default_qubit_legacy.py`, `test_default_qubit_tf.py` `test_default_qubit_torch.py`, `test_state_prep.py`, `test_all_singles_doubles.py` and test_uccsd`) - In `BasisEmbedding`, errors were thrown in `__init__` while in BasisState in `state_vector`. Now they are unified in `__init__`. For this reason, there were tests where the operator was not initialized correctly but no error was thrown since `state_vector` was not being called but now they are detected. To correct this, I have modified the tests: `test_qscript.py`, `test_state_prep.py`, - Now `BasisState` does not decompose `BasisStatePreparation` since we are going to deprecate it. This causes the number of gates after expanding to be affected. In this case I had to modify some test in `test_tape.py`. This PR also solves: - [issue 6008](#6008) - [issue 6007](#6007) - [issue 6006](#6006) --------- Co-authored-by: Isaac De Vlugt <34751083+isaacdevlugt@users.noreply.github.com> Co-authored-by: soranjh <40344468+soranjh@users.noreply.github.com> Co-authored-by: Utkarsh <utkarshazad98@gmail.com>

KetpuntoG added 2 commits July 22, 2024 17:28

some changes

76203d4

black

d18d9dd

KetpuntoG added 3 commits July 22, 2024 17:47

remove patata.py

63d219b

updating some tests

16d039e

some changes

8127a7a

KetpuntoG added 3 commits July 23, 2024 10:11

check tets

049f3a3

Update test_default_qubit_legacy.py

db9e453

Update test_state_prep.py

773e459

solving bugs

e60d3f0

KetpuntoG changed the title ~~[WIP] Clean state prep subroutines~~ [WIP] Make BasisEmbedding an alias of BasisState Jul 23, 2024

trbromley reviewed Jul 23, 2024

View reviewed changes

pennylane/templates/embeddings/basis.py Show resolved Hide resolved

KetpuntoG added 2 commits July 23, 2024 16:52

Merge branch 'master' into clean_state_prep

12f93bf

spsa from master

8ebf755

KetpuntoG changed the title ~~[WIP] Make BasisEmbedding an alias of BasisState~~ [sc-68521] [WIP] Make BasisEmbedding an alias of BasisState Jul 23, 2024

KetpuntoG added 6 commits July 23, 2024 18:09

Merge branch 'master' into clean_state_prep

3841fdd

[skip-ci]

3c4465a

[skip-ci]

Merge branch 'master' into clean_state_prep

733c4a6

fix pylint

989aa11

Update basis.py

99603ec

Update basis.py

fe36eb2

KetpuntoG changed the title ~~[sc-68521] [WIP] Make BasisEmbedding an alias of BasisState~~ [WIP] Make BasisEmbedding an alias of BasisState Jul 24, 2024

KetpuntoG added 2 commits July 24, 2024 18:28

deprecating basisstateprep

5f8ba56

Update basis.py

94ca8bf

KetpuntoG commented Jul 24, 2024

View reviewed changes

doc/development/deprecations.rst Outdated Show resolved Hide resolved

KetpuntoG added 2 commits July 25, 2024 09:19

warning deprecated

3e5e250

Update test_templates.py

9ee26bc

soranjh reviewed Aug 21, 2024

View reviewed changes

pennylane/ops/qubit/state_preparation.py Outdated Show resolved Hide resolved

soranjh requested a review from obliviateandsurrender August 21, 2024 00:40

obliviateandsurrender requested changes Aug 21, 2024

View reviewed changes

KetpuntoG added 3 commits August 21, 2024 09:41

code review comments

c9e66e9

Update state_preparation.py

05823d3

updating test msgs

bf12289

KetpuntoG added this to the v0.38 milestone Aug 21, 2024

KetpuntoG added 4 commits August 21, 2024 14:58

unify changelog

55f9941

Merge branch 'master' into clean_state_prep

c7afd28

Update test_tape.py

5d52014

Merge branch 'clean_state_prep' of https://github.com/PennyLaneAI/pen…

5430b27

…nylane into clean_state_prep

soranjh approved these changes Aug 21, 2024

View reviewed changes

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

soranjh requested a review from obliviateandsurrender August 21, 2024 19:37

obliviateandsurrender approved these changes Aug 21, 2024

View reviewed changes

pennylane/ops/qubit/state_preparation.py Outdated Show resolved Hide resolved

pennylane/ops/qubit/state_preparation.py Outdated Show resolved Hide resolved

KetpuntoG and others added 4 commits August 21, 2024 16:08

Apply suggestions from code review

c4cbc98

Co-authored-by: soranjh <40344468+soranjh@users.noreply.github.com> Co-authored-by: Utkarsh <utkarshazad98@gmail.com>

Merge branch 'master' into clean_state_prep

53d41db

Update test_tape.py

f79135a

Merge branch 'master' into clean_state_prep

e78efb4

KetpuntoG merged commit f00c924 into master Aug 21, 2024
40 checks passed

KetpuntoG deleted the clean_state_prep branch August 21, 2024 23:22

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

paul0403 added a commit to PennyLaneAI/catalyst that referenced this pull request Aug 27, 2024

PL recently changed error messages for bad stateprep/basisstate use c…

71e770b

…ases (PennyLaneAI/pennylane#6021). We update our tests to agree with them.

paul0403 mentioned this pull request Aug 27, 2024

Track PL new stateprep error message PennyLaneAI/catalyst#1057

Merged

This was referenced Sep 6, 2024

[BUG] BasisState does not work with jax.jit #6006

Closed

[BUG] BasisEmbedding gives the wrong decomposition #6007

Closed

[BUG] BasisEmbedding does not work with lightning.qubit and jax.jit #6008

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade and generalise basis state preparation #6021

Upgrade and generalise basis state preparation #6021

KetpuntoG commented Jul 22, 2024 •

edited by Alex-Preciado

Loading

github-actions bot commented Jul 22, 2024

isaacdevlugt commented Jul 22, 2024

KetpuntoG commented Jul 23, 2024

codecov bot commented Jul 23, 2024 •

edited

Loading

soranjh left a comment

obliviateandsurrender left a comment

Upgrade and generalise basis state preparation #6021

Upgrade and generalise basis state preparation #6021

Conversation

KetpuntoG commented Jul 22, 2024 • edited by Alex-Preciado Loading

github-actions bot commented Jul 22, 2024

isaacdevlugt commented Jul 22, 2024

KetpuntoG commented Jul 23, 2024

codecov bot commented Jul 23, 2024 • edited Loading

Codecov Report

soranjh left a comment

Choose a reason for hiding this comment

obliviateandsurrender left a comment

Choose a reason for hiding this comment

KetpuntoG commented Jul 22, 2024 •

edited by Alex-Preciado

Loading

codecov bot commented Jul 23, 2024 •

edited

Loading