New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(LK-C-2) Add controlled named 2/4-qubit gate (e.g. NCIsingXX) support to Lightning Kokkos #953

Merged

josephleekl merged 61 commits into lk-control-base from lk-control-gate-23Q

Nov 12, 2024

Contributor

josephleekl commented Oct 18, 2024 •

edited

Loading

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:

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:

josephleekl added 7 commits

October 18, 2024 19:34


          initial commit

4b9062e


          initial commit

ba70971


          support controlled 1 qubit gate

6ac216a


          add controlled globalphase test

bea8bf7


          fix controlled globalphase return

38c48b9


          format

968b86e


          format

8c97d82

Contributor

github-actions bot commented Oct 18, 2024

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.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.


          format

09b07d5

josephleekl force-pushed the lk-control-gate-23Q branch from 3df0a20 to d99ad20 Compare

October 19, 2024 00:51

josephleekl changed the title ~~add native 2/3 qubit controlled gate support to Lightning Kokkos~~ add native 2/3/4 qubit controlled gate support to Lightning Kokkos


          add globalphase python test

a7106b7

josephleekl force-pushed the lk-control-gate-23Q branch from af0f04d to eaac78f Compare

October 19, 2024 01:25

josephleekl added 3 commits

October 21, 2024 10:10


          apply controlled only for 1 qubit gate

34e6400


          format

b1263fa


          trigger CI

josephleekl force-pushed the lk-control-gate-23Q branch from eaac78f to a1c498f Compare

October 21, 2024 15:17

josephleekl added ci:build_wheels ci:use-gpu-runner labels

josephleekl force-pushed the lk-control-gate-23Q branch from 692c2cf to 5497be5 Compare

October 21, 2024 15:54

josephleekl marked this pull request as ready for review

October 21, 2024 16:08

codecov bot commented Oct 21, 2024 •

edited

Loading

Codecov Report

Attention: Patch coverage is 99.90431% with 1 line in your changes missing coverage. Please review.

Please upload report for BASE (lk-control-base@e89065f). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
...nylane_lightning/lightning_kokkos/_state_vector.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@                Coverage Diff                 @@
##             lk-control-base     #953   +/-   ##
==================================================
  Coverage                   ?   97.00%           
==================================================
  Files                      ?      221           
  Lines                      ?    34366           
  Branches                   ?        0           
==================================================
  Hits                       ?    33338           
  Misses                     ?     1028           
  Partials                   ?        0

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

josephleekl changed the title ~~add native 2/3/4 qubit controlled gate support to Lightning Kokkos~~ Add controlled 2/3/4-qubit gate support to Lightning Kokkos

josephleekl marked this pull request as draft

October 21, 2024 19:50


          fix parity_2_offset to kokkos_inline_function

7ebee0f

josephleekl force-pushed the lk-control-gate-23Q branch from 5497be5 to 2d5b58e Compare

October 21, 2024 20:59

josephleekl marked this pull request as ready for review

October 21, 2024 21:03

josephleekl added the urgent label

josephleekl added 2 commits

October 22, 2024 11:41


          separate generate/control bit patterns

cec599b


          format

a01b38a

josephleekl requested review from AmintorDusko, maliasadi, multiphaseCFD and LuisAlfredoNu and removed request for AmintorDusko

November 8, 2024 22:59

Base automatically changed from lk-control-gate-1Q to lk-control-base

November 8, 2024 23:32

josephleekl force-pushed the lk-control-gate-23Q branch from a2d6fe4 to 82b0b85 Compare

November 9, 2024 00:11

josephleekl changed the base branch from lk-control-base to lk-control-gate-NQ-multiRZ

November 9, 2024 01:00

josephleekl changed the base branch from lk-control-gate-NQ-multiRZ to lk-control-base

November 9, 2024 01:00

josephleekl added 2 commits

November 9, 2024 02:12


          Merge branch 'lk-control-base' into lk-control-gate-23Q

240500e


          fix merge squash

020c215

josephleekl force-pushed the lk-control-gate-23Q branch from b84263f to 020c215 Compare

November 9, 2024 02:15

LuisAlfredoNu reviewed

View reviewed changes

Contributor

LuisAlfredoNu left a comment

Thank you @josephleekl
Only a few questions before to move forward 😄

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Outdated Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Outdated Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Outdated Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

maliasadi reviewed

View reviewed changes

Member

maliasadi left a comment

Nice work @josephleekl! Happy to approve once the last comments have been addressed.

tests/test_gates.py Outdated Show resolved Hide resolved

..._lightning/core/src/simulators/lightning_kokkos/gates/tests/Test_StateVectorKokkos_Param.cpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Outdated Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

josephleekl added 3 commits

November 11, 2024 17:56


          update alfredo comments

b33d680


          update ali comment test instance

b2e278c


          add qml.ctrl test comment

9d93fe4

multiphaseCFD reviewed

View reviewed changes

Member

multiphaseCFD left a comment

Nice work @josephleekl ! Just a few questions.

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

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

                   template <class ExecutionSpace>
                   applyNC2Functor([[maybe_unused]] ExecutionSpace exec,
                                   Kokkos::View<Kokkos::complex<PrecisionT> *> arr_,
-                                  std::size_t num_qubits,
+                                  const std::size_t num_qubits,

Member

multiphaseCFD Nov 12, 2024

Is it necessary to set num_qubits as const for the argument?

Contributor Author

josephleekl Nov 12, 2024

I will keep consistent with the original file that e.g. applyNC2Functor applyNC1Functor etc. does not use const, just std::size_t num_qubits, but I will keep the const std::size_t num_qubits in specific functions applyPauliY. This could be revisited in a later PR.

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGeneratorFunctors.hpp Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGeneratorFunctors.hpp Outdated Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGeneratorFunctors.hpp Show resolved Hide resolved


          update shuli/ali comments

d59df2f

josephleekl requested review from multiphaseCFD, maliasadi and LuisAlfredoNu

November 12, 2024 18:01

Contributor Author

josephleekl commented Nov 12, 2024

I have addressed the comments above, please have a look and approve if ready, thanks! @maliasadi @LuisAlfredoNu @multiphaseCFD

LuisAlfredoNu approved these changes

View reviewed changes

Contributor

LuisAlfredoNu left a comment

Thank you @josephleekl
Nice work!

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Outdated Show resolved Hide resolved

pennylane_lightning/core/src/simulators/lightning_kokkos/gates/BasicGateFunctors.hpp Show resolved Hide resolved

maliasadi approved these changes

View reviewed changes

Member

maliasadi left a comment

LGTM 🥳

multiphaseCFD approved these changes

View reviewed changes

Member

multiphaseCFD left a comment

Thanks @josephleekl ! Nice work


          add util:: namespace

3f1d800

josephleekl merged commit 1979bd7 into lk-control-base

64 of 65 checks passed

josephleekl deleted the lk-control-gate-23Q branch

November 12, 2024 18:21

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:build_wheels ci:use-gpu-runner urgent