Add MPSTNCuda class

.github/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ### New features since last release
 
+* Add `cutensornet` backed `MPS` C++ layer to `lightning.tensor`.
+  [(#704)](https://github.com/PennyLaneAI/pennylane-lightning/pull/704)
+
 ### Breaking changes
 
 ### Improvements
@@ -23,14 +26,17 @@
 
 This release contains contributions from (in alphabetical order):
 
-Amintor Dusko, Pietropaolo Frisoni, Vincent Michaud-Rioux
+Amintor Dusko, Pietropaolo Frisoni, Vincent Michaud-Rioux, Shuli Shu
 
 ---
 
 # Release 0.36.0
 
 ### New features since last release
 
+* Add `cutensornet` backed `MPS` C++ layer to `lightning.tensor`.
+  [(#704)](https://github.com/PennyLaneAI/pennylane-lightning/pull/704)
+
 * Add Python class for the `lightning.tensor` device which uses the new device API and the interface for `quimb` based on the MPS method.
   [(#671)](https://github.com/PennyLaneAI/pennylane-lightning/pull/671)
 

.github/workflows/tests_lmps_tncuda_cpp.yml

@@ -0,0 +1,192 @@
+name: Testing::Linux::x86_64::MPSTNCuda::C++
+# TODO remove MPS from the workflow name and the workflow filename once exact is in.
+# TODO remove the `PL_TENSOR_METHOD` option once exact TN is added.
+# 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:
+      - .github/workflows/tests_lmps_tncuda_cpp.yml
+      - pennylane_lightning/core/src/**
+      - '!pennylane_lightning/core/src/simulators/lightning_kokkos/**'
+      - '!pennylane_lightning/core/src/simulators/lightning_qubit/**'
+      - '!pennylane_lightning/core/src/simulators/lightning_gpu/**'
+  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_cpp-${{ 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
+
+  cpptestswithMPSTNCuda:
+    if: ${{ !contains(fromJSON('["schedule", "workflow_dispatch"]'), github.event_name) }}
+    needs: [builddeps]
+    strategy:
+      matrix:
+        os: [ubuntu-22.04]
+        pl_backend: ["lightning_tensor"]
+        pl_tensor_method: ["mps"]
+        pl_tensor_backend: ["cutensornet"]
+        cuda_version: ["12"]
+
+    name: C++ tests (Lightning-Tensor-MPS-TNCuda)
+    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'
+
+      - 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 => $pip_path"
+          echo "pip=$pip_path" >> $GITHUB_OUTPUT
+      - name: Install required packages
+        run: |
+          python -m pip install ninja cmake scipy custatevec-cu${{ matrix.cuda_version }} cutensornet-cu${{ matrix.cuda_version }}
+      - name: Build and run unit tests
+        run: |
+          set -x
+          cd main
+          cmake . -BBuild \
+            -DCUQUANTUM_SDK=$(python -c "import site; print( f'{site.getsitepackages()[0]}/cuquantum')")\
+            -DBUILD_TESTS=ON \
+            -DENABLE_PYTHON=OFF \
+            -DPL_BACKEND=${{ matrix.pl_backend }} \
+            -DPL_TENSOR_METHOD=${{ matrix.pl_tensor_method }} \
+            -DPL_TENSOR_BACKEND=${{ matrix.pl_tensor_backend }} \
+            -DCMAKE_CXX_COMPILER=$(which g++-$GCC_VERSION) \
+            -DENABLE_COVERAGE=ON \
+            -G Ninja
+          cmake --build ./Build
+          cd ./Build
+          mkdir -p ./tests/results_${{ github.job }}_${{ matrix.pl_backend }}
+          for file in *runner ; do ./$file --order lex --reporter junit --out ./tests/results_${{ github.job }}_${{ matrix.pl_backend }}/report_$file.xml; done;
+          lcov --directory . -b ../pennylane_lightning/core/src --capture --output-file coverage.info
+          lcov --remove coverage.info '/usr/*' --output-file coverage.info
+          mv coverage.info coverage-${{ github.job }}-${{ matrix.pl_backend }}.info
+          set +x
+      - name: Upload test results
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: ubuntu-tests-reports-${{ github.job }}_${{ matrix.pl_backend }}
+          path: ./main/Build/tests/results_${{ github.job }}_${{ matrix.pl_backend }}
+          if-no-files-found: error
+
+      - name: Upload code coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          name: ubuntu-codecov-results-cpp
+          path: ./main/Build/coverage-${{ github.job }}-${{ matrix.pl_backend }}.info
+          if-no-files-found: error
+
+
+  upload-to-codecov-linux-cpp:
+    needs: [cpptestswithMPSTNCuda]
+    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-cpp
+
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: true
+          verbose: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Cleanup
+        if: always()
+        run: |
+          rm -rf ${{ steps.setup_venv.outputs.venv_name }}
+          rm -rf *
+          rm -rf .git
+          rm -rf .gitignore
+          rm -rf .github
+          pip cache purge

CMakeLists.txt

@@ -73,6 +73,11 @@ endif()
 # Print PL_BACKEND
 foreach(BACKEND ${PL_BACKEND})
     message(STATUS "PL_BACKEND: ${BACKEND}")
+    if("${BACKEND}" STREQUAL "lightning_tensor")
+        set(PL_TENSOR_METHOD "mps" CACHE STRING "PennyLane LightningTensor MPS simulator.")
+        set(PL_TENSOR_BACKEND "cutensornet" CACHE STRING "PennyLane LightningTensor backed by cutensornet")
+        set(PL_TENSOR "${PL_BACKEND}_${PL_TENSOR_METHOD}_${PL_TENSOR_BACKEND}")
+    endif()
 endforeach()
 
 # Process compile options

cmake/support_pltensortncuda.cmake

@@ -0,0 +1,54 @@
+###############################################################################################
+# This file provides macros to process cuTensorNet external libraries.
+###############################################################################################
+
+# Include this only once
+include_guard()
+
+# Macro to aid in finding cuTensorNet lib
+macro(findCutensornet external_libs)
+    find_library(CUTENSORNET_LIB
+        NAMES   libcutensornet.so.2 libcutensornet.so
+        HINTS   /usr/lib
+            /usr/local/cuda
+            /usr/local/lib
+            /opt
+            /opt/cuda
+            lib
+            lib64
+            ${CUQUANTUM_SDK}/lib
+            ${CUQUANTUM_SDK}/lib64
+            ${CUDAToolkit_LIBRARY_DIR}
+            ${CUDA_TOOLKIT_ROOT_DIR}/lib
+            ${CUDA_TOOLKIT_ROOT_DIR}/lib64
+            ${Python_SITELIB}/cuquantum/lib
+            ENV LD_LIBRARY_PATH
+    )
+
+    find_file( CUTENSORNET_INC
+        NAMES   cutensornet.h
+        HINTS   /usr/include
+            /usr/local/cuda
+            /usr/local/include
+            /opt
+            /opt/cuda
+            include
+            ${CUQUANTUM_SDK}/include
+            ${CUDAToolkit_INCLUDE_DIRS}
+            ${CUDA_TOOLKIT_ROOT_DIR}/include
+            ${Python_SITELIB}/cuquantum/include
+            ENV CPATH
+    )
+
+    if(NOT CUTENSORNET_LIB OR NOT CUTENSORNET_INC)
+        message(FATAL_ERROR "\nUnable to find cuQuantum SDK installation. Please ensure it is correctly installed and available on path.")
+    else()
+        add_library(cutensornet SHARED IMPORTED GLOBAL)
+
+        get_filename_component(CUTENSORNET_INC_DIR ${CUTENSORNET_INC} DIRECTORY)
+        target_include_directories(cutensornet INTERFACE ${CUTENSORNET_INC_DIR})
+        set_target_properties(cutensornet PROPERTIES IMPORTED_LOCATION ${CUTENSORNET_LIB})
+
+        target_link_libraries(${external_libs} INTERFACE cutensornet)
+    endif()
+endmacro()

pennylane_lightning/core/_version.py

@@ -16,4 +16,4 @@
    Version number (major.minor.patch[-label])
 """
 
-__version__ = "0.37.0-dev3"
+__version__ = "0.37.0-dev4"

pennylane_lightning/core/src/CMakeLists.txt

@@ -13,9 +13,15 @@ set(COMPONENT_SUBDIRS   algorithms
                         simulators
                         utils
 )
-foreach(COMP ${COMPONENT_SUBDIRS})
-    add_subdirectory(${COMP})
-endforeach()
+
+if("${PL_BACKEND}" STREQUAL "lightning_tensor")
+    add_subdirectory(simulators)
+    add_subdirectory(utils)
+else()
+    foreach(COMP ${COMPONENT_SUBDIRS})
+        add_subdirectory(${COMP})
+    endforeach()
+endif()
 
 if (BUILD_TESTS)
     # Include macros supporting tests.

pennylane_lightning/core/src/simulators/CMakeLists.txt

@@ -2,8 +2,9 @@ cmake_minimum_required(VERSION 3.20)
 
 project(lightning_simulators LANGUAGES CXX)
 
-add_subdirectory(base)
-
+if(NOT "${PL_BACKEND}" STREQUAL "lightning_tensor")
+    add_subdirectory(base)
+endif()
 ###############################################################################
 # Determine simulator and include its directory
 ###############################################################################

pennylane_lightning/core/src/simulators/lightning_tensor/CMakeLists.txt

@@ -0,0 +1,19 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(lightning_tensor LANGUAGES CXX)
+
+###############################################################################
+# Include all nested sources directories
+###############################################################################
+set(COMPONENT_SUBDIRS   utils 
+                        tensor)
+
+if("${PL_TENSOR_BACKEND}" STREQUAL "cutensornet")
+    list(APPEND COMPONENT_SUBDIRS tncuda)
+else()
+    message(FATAL_ERROR "Lightning Tensor currently doesn't support ${PL_TENSOR_BACKEND} method")
+endif()
+
+foreach(COMP ${COMPONENT_SUBDIRS})
+    add_subdirectory(${COMP})
+endforeach()

pennylane_lightning/core/src/simulators/lightning_tensor/tensor/CMakeLists.txt

@@ -0,0 +1,20 @@
+cmake_minimum_required(VERSION 3.20)
+project(${PL_BACKEND}_tensor LANGUAGES CXX)
+
+add_library(${PL_BACKEND}_tensor INTERFACE)
+
+add_subdirectory(base)
+
+set(TNCUDA_UTILS_ADDED FALSE CACHE BOOL "Add tncuda_utils header files")
+
+if("${PL_TENSOR_BACKEND}" STREQUAL "cutensornet" AND NOT TNCUDA_UTILS_ADDED)
+    add_subdirectory(tncuda)
+    target_include_directories(${PL_BACKEND}_tensor INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/tncuda)
+    target_link_libraries(${PL_BACKEND}_tensor INTERFACE tensor_cuda)
+    set(CUDA_UTILS_ADDED TRUE)
+endif()
+
+target_include_directories(${PL_BACKEND}_tensor INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/base)
+target_link_libraries(${PL_BACKEND}_tensor INTERFACE tensorBase lightning_utils lightning_compile_options lightning_external_libs)
+
+set_property(TARGET ${PL_BACKEND}_tensor PROPERTY POSITION_INDEPENDENT_CODE ON)

pennylane_lightning/core/src/simulators/lightning_tensor/tensor/base/CMakeLists.txt

@@ -0,0 +1,10 @@
+cmake_minimum_required(VERSION 3.20)
+project(tensorBase LANGUAGES CXX)
+
+add_library(tensorBase INTERFACE)
+
+
+target_include_directories(tensorBase INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
+target_link_libraries(tensorBase INTERFACE lightning_utils lightning_compile_options lightning_external_libs)
+
+set_property(TARGET tensorBase PROPERTY POSITION_INDEPENDENT_CODE ON)