-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
### 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:**
Add both `python` and `pybind` layer to the `lightning.tensor`-`mps`
device.
1. Gates supported: Operators that have 1 or 2 wires or can be
decomposed into 1-2 wires gates. `MultiRZ` gate is not supported.
2. Obs supported: All obs supported in `lightning` state vector backends
except for `qml.Projector` and `SparseHamiltionian`
3. Both `qml.QubitStateVector` and `qml.StatePrep` are not supported.
4. `qml.state()` is not supported and the `state()` returns a
`LightningStateTensor` object represents the whole compute graph
5. `qml.BasisState` only accepts array representation of a basis state.
A `int` value can only supports up to `32` qubit system.
6. `qml.expval` is the only measurement `lightning.tensor` support.
7. Limited `gradient support` with `parameter-shift`. And a `100` qubits
SEL circuit was tested on `A100 80 GB GPU`
8. `maxBondDim` is default as `128`.
9. `pip` editable installation with `PL_BACKEND="lightning_tensor" pip
install -e .`, given that `cutensornet-cu12` is installed an `venv` env.
Detailed instructions are on[
PR#756](#756).
10. `lightning.tensor` is also tested against all the tests in `tests/`
if the tested feature is supported in `lightning.tensor`. The skipped
tests are tasks for the next step.
11.
[SC-62440] [SC-62439] [SC-60329] [SC-60325]
**Description of the Change:**
**Benefits:**
**Possible Drawbacks:**
**Related GitHub Issues:**
---------
Co-authored-by: ringo-but-quantum <[email protected]>
Co-authored-by: Ali Asadi <[email protected]>
Co-authored-by: Mudit Pandey <[email protected]>
Co-authored-by: Vincent Michaud-Rioux <[email protected]>
Co-authored-by: Vincent Michaud-Rioux <[email protected]>
Co-authored-by: Amintor Dusko <[email protected]>- Loading branch information
7 people
authored
Jun 12, 2024
1 parent
f57df46
commit 75d9c92
Showing
47 changed files
with
2,260 additions
and
228 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| name: Testing::Linux::x86_64::MPSTNCuda::Python | ||
| # TODO remove MPS from the workflow name and the workflow filename once exact is in. | ||
| # TODO remove the `pl_tensor_method` once exact TN is added. | ||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| lightning-version: | ||
| type: string | ||
| required: true | ||
| description: The version of Lightning to use. Valid values are either 'release' (most recent release candidate), 'stable' (most recent git-tag) or 'latest' (most recent commit from master) | ||
| pennylane-version: | ||
| type: string | ||
| required: true | ||
| description: The version of PennyLane to use. Valid values are either 'release' (most recent release candidate), 'stable' (most recent git-tag) or 'latest' (most recent commit from master) | ||
| release: | ||
| pull_request: | ||
| paths-ignore: | ||
| - .github/** | ||
| - '!.github/workflows/tests_lmps_tncuda_python.yml' | ||
| - pennylane_lightning/core/src/simulators/lightning_kokkos/** | ||
| - pennylane_lightning/core/src/simulators/lightning_qubit/** | ||
| - pennylane_lightning/core/src/simulators/lightning_gpu/** | ||
| - pennylane_lightning/core/_version.py | ||
| - pennylane_lightning/lightning_gpu/** | ||
| - pennylane_lightning/lightning_qubit/** | ||
| - pennylane_lightning/lightning_kokkos/** | ||
| push: | ||
| branches: | ||
| - master | ||
|
|
||
| env: | ||
| CI_CUDA_ARCH: 86 | ||
| COVERAGE_FLAGS: "--cov=pennylane_lightning --cov-report=term-missing --cov-report=xml:./coverage.xml --no-flaky-report -p no:warnings --tb=native" | ||
| GCC_VERSION: 11 | ||
|
|
||
| concurrency: | ||
| group: tests_lmps_tncuda_python-${{ github.ref }}-${{ github.event }}-${{ inputs.lightning-version }}-${{ inputs.pennylane-version }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| builddeps: | ||
| runs-on: | ||
| - self-hosted | ||
| - ubuntu-22.04 | ||
| - gpu | ||
|
|
||
| strategy: | ||
| max-parallel: 1 | ||
| matrix: | ||
| os: [ubuntu-22.04] | ||
| pl_backend: ["lightning_tensor"] | ||
| cuda_version: ["12"] | ||
|
|
||
| steps: | ||
| - name: Validate GPU version and installed compiler | ||
| run: | | ||
| source /etc/profile.d/modules.sh | ||
| module use /opt/modules | ||
| module load cuda/${{ matrix.cuda_version }} | ||
| echo "${PATH}" >> $GITHUB_PATH | ||
| echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}" >> $GITHUB_ENV | ||
| nvcc --version | ||
| nvidia-smi | ||
| pythontestswithMPSTNCuda: | ||
| if: ${{ !contains(fromJSON('["schedule", "workflow_dispatch"]'), github.event_name) }} | ||
| needs: [builddeps] | ||
| strategy: | ||
| matrix: | ||
| os: [ubuntu-22.04] | ||
| pl_backend: ["lightning_tensor"] | ||
| default_backend: ["lightning_qubit"] | ||
| pl_tensor_method: ["mps"] | ||
| pl_tensor_backend: ["cutensornet"] | ||
| cuda_version: ["12"] | ||
|
|
||
| name: Python Tests (${{ matrix.pl_backend }}, method-${{ matrix.pl_tensor_method }}, backend-${{ matrix.pl_tensor_backend }}, cuda-${{ matrix.cuda_version }}) | ||
| runs-on: | ||
| - ${{ matrix.os }} | ||
| - self-hosted | ||
| - gpu | ||
|
|
||
| steps: | ||
| - name: Validate GPU version and installed compiler | ||
| run: | | ||
| source /etc/profile.d/modules.sh | ||
| module use /opt/modules | ||
| module load cuda/${{ matrix.cuda_version }} | ||
| echo "${PATH}" >> $GITHUB_PATH | ||
| echo "LD_LIBRARY_PATH=${LD_LIBRARY_PATH}" >> $GITHUB_ENV | ||
| nvcc --version | ||
| nvidia-smi | ||
| - name: Checkout PennyLane-Lightning-Tensor-MPS-TNCuda | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| path: main | ||
|
|
||
| - uses: actions/setup-python@v5 | ||
| name: Install Python | ||
| with: | ||
| python-version: '3.9' | ||
|
|
||
| # Since the self-hosted runner can be re-used. It is best to set up all package | ||
| # installations in a virtual environment that gets cleaned at the end of each workflow run | ||
| - name: Setup Python virtual environment | ||
| id: setup_venv | ||
| env: | ||
| VENV_NAME: ${{ github.workspace }}/venv_${{ steps.setup_python.outputs.python-version }}_${{ github.sha }} | ||
| run: | | ||
| # Clear any pre-existing venvs | ||
| rm -rf venv_* | ||
| # Create new venv for this workflow_run | ||
| python --version | ||
| python -m venv ${{ env.VENV_NAME }} | ||
| # Add the venv to PATH for subsequent steps | ||
| echo ${{ env.VENV_NAME }}/bin >> $GITHUB_PATH | ||
| # Adding venv name as an output for subsequent steps to reference if needed | ||
| echo "venv_name=${{ env.VENV_NAME }}" >> $GITHUB_OUTPUT | ||
| - name: Display Python-Path | ||
| id: python_path | ||
| run: | | ||
| py_path=$(which python) | ||
| echo "Python Interpreter Path => $py_path" | ||
| echo "python=$py_path" >> $GITHUB_OUTPUT | ||
| pip_path=$(which python) | ||
| echo "PIP Path => $py_path" | ||
| echo "pip=$py_path" >> $GITHUB_OUTPUT | ||
| - name: Install required packages | ||
| run: | | ||
| cd main | ||
| python -m pip install -r requirements-dev.txt | ||
| python -m pip install ninja cmake scipy custatevec-cu${{ matrix.cuda_version }} cutensornet-cu${{ matrix.cuda_version }} openfermionpyscf | ||
| - name: Checkout PennyLane for release build | ||
| if: inputs.pennylane-version == 'release' | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| path: pennylane | ||
| repository: PennyLaneAI/pennylane | ||
|
|
||
| - name: Switch to release build of PennyLane | ||
| if: inputs.pennylane-version == 'release' | ||
| run: | | ||
| cd pennylane | ||
| git fetch --all | ||
| git checkout $(git branch -a --list "origin/v*rc*" | tail -1) | ||
| python -m pip uninstall -y pennylane && python -m pip install . -vv --no-deps | ||
| - name: Install Stable PennyLane | ||
| if: inputs.pennylane-version == 'stable' | ||
| run: | | ||
| cd main | ||
| python -m pip uninstall -y pennylane && python -m pip install -U pennylane | ||
| - name: Build and install package | ||
| run: | | ||
| cd main | ||
| rm -rf build | ||
| CMAKE_ARGS="-DPL_BACKEND=${{ matrix.default_backend }} -DCMAKE_CXX_COMPILER=$(which g++-$GCC_VERSION)" \ | ||
| python -m pip install . -vv | ||
| rm -rf build | ||
| rm -rf build | ||
| CMAKE_ARGS="-DPL_BACKEND=${{ matrix.pl_backend }} -DCMAKE_CXX_COMPILER=$(which g++-$GCC_VERSION)" \ | ||
| python -m pip install . -vv | ||
|
|
||
| - name: Run PennyLane-Lightning-Tensor unit tests | ||
| if: ${{ matrix.pl_backend != 'all'}} | ||
| run: | | ||
| cd main/ | ||
| DEVICENAME=`echo ${{ matrix.pl_backend }} | sed "s/_/./g"` | ||
| PL_DEVICE=${DEVICENAME} python -m pytest tests $COVERAGE_FLAGS | ||
| mv coverage.xml coverage-${{ github.job }}-${{ matrix.pl_backend }}.xml | ||
| - name: Upload code coverage results | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: ubuntu-codecov-results-python | ||
| path: ./main/coverage-${{ github.job }}-${{ matrix.pl_backend }}.xml | ||
| if-no-files-found: error | ||
|
|
||
|
|
||
| upload-to-codecov-linux-python: | ||
| needs: [pythontestswithMPSTNCuda] | ||
| name: Upload coverage data to codecov | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Download coverage reports | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: ubuntu-codecov-results-python | ||
|
|
||
| - name: Upload to Codecov | ||
| uses: codecov/codecov-action@v4 | ||
| with: | ||
| fail_ci_if_error: true | ||
| verbose: true | ||
| token: ${{ secrets.CODECOV_TOKEN }} |
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,4 +16,4 @@ | |
| Version number (major.minor.patch[-label]) | ||
| """ | ||
|
|
||
| __version__ = "0.37.0-dev32" | ||
| __version__ = "0.37.0-dev33" | ||
Oops, something went wrong.