(LK-C-Base) Add native controlled operation support for Lightning Kokkos #950

josephleekl · 2024-10-18T19:10:23Z

Before submitting

Please complete the following checklist when submitting a PR:

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 directory!
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.
Ensure that the test suite passes, by running make test.
Add a new entry to the .github/CHANGELOG.md file, summarizing the
change, and including a link back to the PR.
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:
Native arbitrary controlled operations have already been implemented in Lightning Qubit and Lightning GPU. This PR adds support for controlled operations to Lightning Kokkos as well. This PR is the base branch of combination of multiple PRs (1, 2, 3, 4, 5, 6, 7)

Description of the Change:
Controlled named-gates, matrix, generators, and adjoint differentiation capability is added to Lightning Kokkos C++ layer.

Benefits:
Better performance for controlled operations in Lightning Kokkos (CPU + GPU). Adjoint differentiation now supported in Lightning Kokkos.

Possible Drawbacks:

Related GitHub Issues:

[sc-78995]

codecov · 2024-10-24T01:02:44Z

Codecov Report

Attention: Patch coverage is 99.53235% with 12 lines in your changes missing coverage. Please review.

Project coverage is 95.85%. Comparing base (74ad9a3) to head (9582e93).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
...nylane_lightning/lightning_kokkos/_state_vector.py	0.00%	10 Missing ⚠️
...c/simulators/lightning_kokkos/utils/UtilKokkos.hpp	96.15%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #950      +/-   ##
==========================================
- Coverage   97.29%   95.85%   -1.44%     
==========================================
  Files         229      229              
  Lines       36908    38841    +1933     
==========================================
+ Hits        35909    37232    +1323     
- Misses        999     1609     +610

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

… Lightning Kokkos (#952) ### Before submitting Please complete the following checklist when submitting a PR: - [ ] 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! - [ ] 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`. - [ ] Ensure that the test suite passes, by running `make test`. - [ ] Add a new entry to the `.github/CHANGELOG.md` file, summarizing the change, and including a link back to the PR. - [ ] 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:** **Description of the Change:** This PR adds support for named controlled 1-qubit gates (e.g. PauliX / RX / PhaseShift / Hadamard / Rot / GlobalPhase). These are defined in `BasicGateFunctors.hpp`, and are applied through `applyNC1Functor` defined in the same file. **Benefits:** Performance benchmarks for gates are shown here: https://www.notion.so/xanaduai/Lightning-Kokkos-Native-Controlled-Operation-Gate-Benchmarks-12ebc6bd17648017a2dcd237748b24fe **Possible Drawbacks:** **Related GitHub Issues:** [sc-76773]

… to Lightning Kokkos (#953) ### Before submitting Please complete the following checklist when submitting a PR: - [ ] 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! - [ ] 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`. - [ ] Ensure that the test suite passes, by running `make test`. - [ ] Add a new entry to the `.github/CHANGELOG.md` file, summarizing the change, and including a link back to the PR. - [ ] 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:** **Description of the Change:** This PR adds support for named controlled 2/4-qubit gates (e.g. Swap / IsingXX / SingleExcitation / Double Excitation). These are defined in `BasicGateFunctor.hpp`, and are applied through `applyNC2Functor` and `applyNC4Functor` defined in the same file. **Benefits:** Performance benchmarks for gates are shown here: https://www.notion.so/xanaduai/Lightning-Kokkos-Native-Controlled-Operation-Gate-Benchmarks-12ebc6bd17648017a2dcd237748b24fe **Possible Drawbacks:** **Related GitHub Issues:** [sc-76774]

### Before submitting Please complete the following checklist when submitting a PR: - [ ] 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! - [ ] 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`. - [ ] Ensure that the test suite passes, by running `make test`. - [ ] Add a new entry to the `.github/CHANGELOG.md` file, summarizing the change, and including a link back to the PR. - [ ] 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:** **Description of the Change:** This PR adds support for controlled multiRZ for Lightning Kokkos. This is defined in `BasicGateFunctor.hpp`, and is applied through `applyNCNFunctor` defined in the same file. **Benefits:** Performance benchmarks for gates are shown here: https://www.notion.so/xanaduai/Lightning-Kokkos-Native-Controlled-Operation-Gate-Benchmarks-12ebc6bd17648017a2dcd237748b24fe **Possible Drawbacks:** **Related GitHub Issues:** [sc-76775]

### Before submitting Please complete the following checklist when submitting a PR: - [ ] 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! - [ ] 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`. - [ ] Ensure that the test suite passes, by running `make test`. - [ ] Add a new entry to the `.github/CHANGELOG.md` file, summarizing the change, and including a link back to the PR. - [ ] 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:** **Description of the Change:** This PR adds support for controlled QubitUnitary for Lightning Kokkos. There are specialized implementations for 1/2/3-qubits (`applyNC1/2/3QubitOpFunctor`) and a general case implementation (`NCMultiQubitOpFunctor`). These functors are defined in `MatrixGateFunctors.hpp`. These are called by `applyControlledMatrix` or `applyOperation`/`applyNCMultiQubitOp` in `StateVectorKokkos.hpp` **Benefits:** Performance benchmarks for gates are shown here: https://www.notion.so/xanaduai/Lightning-Kokkos-Native-Controlled-Operation-Gate-Benchmarks-12ebc6bd17648017a2dcd237748b24fe **Possible Drawbacks:** **Related GitHub Issues:** [sc-76776]

multiphaseCFD · 2024-12-02T15:17:39Z

Is ControlledGlobalPhase supported?

Yes Controlled(GlobalPhase) is supported, I have removed the old branch for controlled global phase which is no longer used. Good catch and thanks!

Thanks @josephleekl . Nice one! It only needs 1 param passed to the device for the C(GlobalPhase), which could improve the performance at large.

multiphaseCFD

Thanks @josh146 ! LGTM. Will approve after this final round.

pennylane_lightning/core/src/simulators/lightning_kokkos/StateVectorKokkos.hpp

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/MatrixGateFunctors.hpp

maliasadi

Great work @josephleekl! Happy to approve 🥳

pennylane_lightning/core/src/simulators/lightning_kokkos/utils/UtilKokkos.hpp

multiphaseCFD

Nice work! Happy to approve.

…/UtilKokkos.hpp Co-authored-by: Ali Asadi <[email protected]>

josephleekl added the WIP Work-in-progress issue. Not for general fixing. label Oct 18, 2024

initial commit

fd9df9f

josephleekl force-pushed the lk-control-base branch from d5ae740 to fd9df9f Compare October 18, 2024 19:38

ringo-but-quantum and others added 3 commits October 18, 2024 19:39

Auto update version from '0.39.0-dev46' to '0.39.0-dev47'

942c841

Merge branch 'master' into lk-control-base

39785ee

Auto update version from '0.39.0-dev47' to '0.39.0-dev48'

035bea0

josephleekl changed the title ~~Add native controlled operation support for Lightning Kokkos (Base)~~ (LK-C-Base) Add native controlled operation support for Lightning Kokkos Oct 23, 2024

josephleekl added ci:build_wheels Activate wheel building. ci:use-gpu-runner Enable usage of GPU runner for this Pull Request labels Oct 24, 2024

josephleekl marked this pull request as ready for review October 24, 2024 00:57

josephleekl and others added 2 commits October 24, 2024 09:03

Merge branch 'master' into lk-control-base

ba5439e

Auto update version from '0.39.0-dev48' to '0.39.0-dev49'

78d4f7b

josephleekl added the urgent Mark a pull request as high priority label Oct 24, 2024

josephleekl and others added 16 commits November 8, 2024 14:47

Merge branch 'master' into lk-control-base

4526b00

merge with master

a964795

Auto update version from '0.40.0-dev4' to '0.40.0-dev5'

0f5beee

Auto update version from '0.40.0-dev5' to '0.40.0-dev6'

e89065f

Auto update version from '0.40.0-dev4' to '0.40.0-dev7'

0acc148

Auto update version from '0.40.0-dev7' to '0.40.0-dev9'

7ea9296

Merge branch 'master' into lk-control-base

56b1d04

format

eb2ac82

fix code factor

8e578b1

Auto update version from '0.40.0-dev9' to '0.40.0-dev10'

7b5713e

Merge branch 'master' into lk-control-base

b00dbf9

Auto update version from '0.40.0-dev11' to '0.40.0-dev12'

5ab8064

ringo-but-quantum and others added 9 commits November 28, 2024 23:29

Auto update version from '0.40.0-dev22' to '0.40.0-dev24'

b678095

format

19ffddc

clean up doc comments

647ef52

update ctrl/adj nested comment

a4df6c0

update non-const pointer applycontrolledmatrix and add test

95cd1db

format

f0ac952

update scratch level exploration comment

f42ea8b

precompute mask in controlbitpatterns calc

f4f2527

Merge branch 'master' into lk-control-base

fd27096

josephleekl marked this pull request as ready for review November 29, 2024 17:04

josephleekl requested review from AmintorDusko, multiphaseCFD, LuisAlfredoNu and maliasadi December 2, 2024 14:41

multiphaseCFD reviewed Dec 2, 2024

View reviewed changes

implement shuli comments

e33fc53

josephleekl marked this pull request as draft December 2, 2024 19:34

implement shuli comments

083dc97

josephleekl marked this pull request as ready for review December 2, 2024 20:13

maliasadi approved these changes Dec 3, 2024

View reviewed changes

pennylane_lightning/core/src/simulators/lightning_kokkos/utils/UtilKokkos.hpp Outdated Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/utils/UtilKokkos.hpp Show resolved Hide resolved

multiphaseCFD approved these changes Dec 3, 2024

View reviewed changes

josephleekl and others added 6 commits December 3, 2024 17:05

Update pennylane_lightning/core/src/simulators/lightning_kokkos/utils…

3a03af2

…/UtilKokkos.hpp Co-authored-by: Ali Asadi <[email protected]>

Auto update version from '0.40.0-dev24' to '0.40.0-dev25'

7d04fd3

Merge branch 'master' into lk-control-base

2bd4058

update controlBitPatterns case

5cdc1fa

Auto update version from '0.40.0-dev25' to '0.40.0-dev26'

0d2e228

Merge branch 'master' into lk-control-base

9582e93

josephleekl merged commit 158d393 into master Dec 4, 2024
116 of 118 checks passed

josephleekl deleted the lk-control-base branch December 4, 2024 14:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(LK-C-Base) Add native controlled operation support for Lightning Kokkos #950

(LK-C-Base) Add native controlled operation support for Lightning Kokkos #950

josephleekl commented Oct 18, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading

multiphaseCFD commented Dec 2, 2024 •

edited

Loading

multiphaseCFD left a comment

maliasadi left a comment

multiphaseCFD left a comment

(LK-C-Base) Add native controlled operation support for Lightning Kokkos #950

(LK-C-Base) Add native controlled operation support for Lightning Kokkos #950

Conversation

josephleekl commented Oct 18, 2024 • edited Loading

Before submitting

codecov bot commented Oct 24, 2024 • edited Loading

Codecov Report

multiphaseCFD commented Dec 2, 2024 • edited Loading

multiphaseCFD left a comment

Choose a reason for hiding this comment

maliasadi left a comment

Choose a reason for hiding this comment

multiphaseCFD left a comment

Choose a reason for hiding this comment

josephleekl commented Oct 18, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading

multiphaseCFD commented Dec 2, 2024 •

edited

Loading