Migration of lightning.gpu device to the new device API
#853
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### 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`.
- [ ] 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:**
Migrate the lightning.kokkos device to the new device API.
**Description of the Change:**
The 'simulate' method is necessary to achieve full functionality with
the new device API.
We are going to follow the same recipe used with LightningQubit.
**Benefits:**
Add one of the essential methods for the new device API into
LightningKokkos.
**Possible Drawbacks:**
**Related GitHub Issues:**
## Partial / Freezzed PR ⚠️ ❄️
To make a smooth integration of LightningKokkos with the new device API,
we set the branch `kokkosNewAPI_backend` as the base branch target for
this development.
The branch `kokkosNewAPI_backend` has the mock of all classes and
methods necessary for the new API. Also, several tests were disabled
with
``` python
if device_name == "lightning.kokkos":
pytest.skip("Kokkos new API in WIP. Skipping.",allow_module_level=True)
```
Additionally, the CI testing from PennyLane for LKokkos is temporally
disabled through commenting the following lines in `.github/workflows`
files
``` yml
: # pl-device-test --device ${DEVICENAME} --skip-ops --shots=20000 $COVERAGE_FLAGS --cov-append
: # pl-device-test --device ${DEVICENAME} --shots=None --skip-ops $COVERAGE_FLAGS --cov-append
```
However, these tests will unblocked as the implementation progresses.
After all the developments for integrating LightningKokkos with the new
API have been completed then the PR will be open to merge to master
[sc-68801]
---------
Co-authored-by: Vincent Michaud-Rioux <[email protected]>
Co-authored-by: Ali Asadi <[email protected]>
### 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`.
- [ ] 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:**
Migrate the lightning.kokkos device to the new device API.
**Description of the Change:**
The 'jacobian' and vjp` methods are necessary to achieve full
functionality with the new device API.
We are going to follow the same recipe used with LightningQubit.
**Benefits:**
Add two of the essential methods for the new device API into
LightningKokkos.
**Possible Drawbacks:**
**Related GitHub Issues:**
## Partial / Freezzed PR ⚠️ ❄️
To make a smooth integration of LightningKokkos with the new device API,
we set the branch kokkosNewAPI_backend as the base branch target for
this development.
The branch kokkosNewAPI_backend has the mock of all classes and methods
necessary for the new API. Also, several tests were disabled with
```python
if device_name == "lightning.kokkos":
pytest.skip("Kokkos new API in WIP. Skipping.",allow_module_level=True)
```
Additionally, the CI testing from PennyLane for LKokkos is temporally
disabled through commenting on the following lines in .github/workflows
files
```bash
: # pl-device-test --device ${DEVICENAME} --skip-ops --shots=20000 $COVERAGE_FLAGS --cov-append
: # pl-device-test --device ${DEVICENAME} --shots=None --skip-ops $COVERAGE_FLAGS --cov-append
```
However, these tests will unblocked as the implementation progresses.
After all the developments for integrating LightningKokkos with the new
API have been completed then the PR will be open to merging to master
[sc-68808] [sc-68814]
---------
Co-authored-by: Vincent Michaud-Rioux <[email protected]>
Co-authored-by: Ali Asadi <[email protected]>
…836) ### 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`. - [ ] 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:** Migrate the lightning.kokkos device to the new device API. **Description of the Change:** Add the necessary method for the LightningKokkos that allows the use of new device API. It should have a similar structure as the LightningQubit class. Note: Lightning Kokkos does not support MCMC sampling. **Benefits:** Integration of LighntingKokkos with the new device API. **Possible Drawbacks:** **Related GitHub Issues:** ## Partial / Freezzed PR⚠️ ❄️ To make a smooth integration of LightningKokkos with the new device API, we set the branch `kokkosNewAPI_backend` as the base branch target for this development. The branch `kokkosNewAPI_backend` has the mock of all classes and methods necessary for the new API. Also, several tests were disabled with ```python if device_name == "lightning.kokkos": pytest.skip("Kokkos new API in WIP. Skipping.",allow_module_level=True) ``` Additionally, the CI testing from PennyLane for LKokkos is temporally disabled through commenting on the following lines in .github/workflows files ``` : # pl-device-test --device ${DEVICENAME} --skip-ops --shots=20000 $COVERAGE_FLAGS --cov-append : # pl-device-test --device ${DEVICENAME} --shots=None --skip-ops $COVERAGE_FLAGS --cov-append ``` However, these tests will unblocked as the implementation progresses. After all the developments for integrating LightningKokkos with the new API have been completed then the PR will be open to merging to master [sc-68820] --------- Co-authored-by: Vincent Michaud-Rioux <[email protected]> Co-authored-by: Ali Asadi <[email protected]> Co-authored-by: Amintor Dusko <[email protected]>
### 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`.
- [ ] 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:**
Migrate the lightning.kokkos device to the new device API.
**Description of the Change:**
Unlock and modify all the unit tests for `Lightning Kokkos` and pass all
the CI.
**Benefits:**
Integration of LighntingKokkos with the new device API.
**Possible Drawbacks:**
**Related GitHub Issues:**
## Partial / Freezzed PR ⚠️ ❄️
To make a smooth integration of LightningKokkos with the new device API,
we set the branch `kokkosNewAPI_backend` as the base branch target for
this development.
The branch `kokkosNewAPI_backend` has the mock of all classes and
methods necessary for the new API. Also, several tests were disabled
with
```python
if device_name == "lightning.kokkos":
pytest.skip("Kokkos new API in WIP. Skipping.",allow_module_level=True)
```
Additionally, the CI testing from PennyLane for LKokkos is temporally
disabled through commenting on the following lines in .github/workflows
files
```
: # pl-device-test --device ${DEVICENAME} --skip-ops --shots=20000 $COVERAGE_FLAGS --cov-append
: # pl-device-test --device ${DEVICENAME} --shots=None --skip-ops $COVERAGE_FLAGS --cov-append
```
However, these tests will unblocked as the implementation progresses.
After all the developments for integrating LightningKokkos with the new
API have been completed then the PR will be open to merging to master
[sc-68823]
---------
Co-authored-by: Vincent Michaud-Rioux <[email protected]>
Co-authored-by: Ali Asadi <[email protected]>
Co-authored-by: Amintor Dusko <[email protected]>
maliasadi
reviewed
Oct 2, 2024
pennylane_lightning/core/src/simulators/lightning_gpu/bindings/LGPUBindingsMPI.hpp
Outdated
Show resolved
Hide resolved
…lightning into gpuNewAPI_backend
multiphaseCFD
approved these changes
Oct 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
testsdirectory!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.mdfile, summarizing thechange, 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:
Following the design of Lightning Qubit and Lightning Kokkos that use the New Device API, we can now migrate Lightning GPU device to the new device API.
Description of the Change:
Migration of Lightning GPU with MPI support to integrate the New device API. The list of main feature changes are
MPIHandlerstate_vector,measurements, andadjoint-jacobianclasses forlightning.gpu.simulate,jacobian,simulate_and_jacobian,vjp, andsimulate_and_vjpmethods tolighting.gpu.lightning.gpuwith the New device API.lightning.gpuBenefits:
Full integration of Lightning GPU with the new device API.
Possible Drawbacks:
Related GitHub Issues:
[sc-70964] [sc-59219]