Merge branch 'master' into feature/elem-wise-strides

Author: Alexander-Makaryev

.github/workflows/build-sphinx.yml

@@ -45,7 +45,8 @@ jobs:
         uses: conda-incubator/setup-miniconda@v2
         with:
           activate-environment: dpnp
-          python-version: 3.7
+          python-version: 3.8
+          channels: intel,conda-forge
           auto-activate-base: false
       - name: Conda info
         shell: bash -l {0}
@@ -55,22 +56,26 @@ jobs:
       - name: Install sphinx dependencies
         shell: bash -l {0}
         run: |
-          conda install numpy cython sphinx sphinx_rtd_theme wheel
+          conda install sphinx sphinx_rtd_theme
+      - name: Install dpnp dependencies
+        shell: bash -l {0}
+        run: |
+          conda install dpctl mkl-devel-dpcpp tbb-devel dpcpp_linux-64 cmake=3.19 cython pytest \
+                        -c dppy/label/dev -c intel -c conda-forge
       - name: Install cuPy dependencies
         shell: bash -l {0}
         run: |
           conda install -c conda-forge cupy cudatoolkit=10.0
       - name: Build library
         shell: bash -l {0}
         run: |
-          . /opt/intel/oneapi/setvars.sh
-          . ./scripts/install_cmake_lin.sh
-          ./0.build.sh
+          python setup.py build_clib
+          CC=dpcpp python setup.py build_ext --inplace
+          python setup.py develop
       - name: Build docs
         shell: bash -l {0}
         run: |
-          . /opt/intel/oneapi/setvars.sh
-          ./0.builddoc.sh
+          make html
         working-directory: doc
       # https://github.com/marketplace/actions/doxygen-action
       - name: Build backend docs

0.build.sh

@@ -1,16 +1,16 @@
 #!/bin/bash
 THEDIR=$(dirname $(readlink -e ${BASH_SOURCE[0]}))
 
-. ${THEDIR}/0.env.sh
+# . ${THEDIR}/0.env.sh
 cd ${THEDIR}
 
 export DPNP_DEBUG=1
 
 python setup.py clean
-python setup.py build_clib
+DPLROOT=/opt/intel/oneapi/dpl/latest python setup.py build_clib
 
 # inplace build
-python setup.py build_ext --inplace
+CC=dpcpp python setup.py build_ext --inplace
 
 # development build. Root privileges needed
 # python setup.py develop

README.md

@@ -2,7 +2,7 @@
 [![codecov](https://codecov.io/gh/IntelPython/dpnp/branch/master/graph/badge.svg)](https://codecov.io/gh/IntelPython/dpnp)
 [![Build Sphinx](https://github.com/IntelPython/dpnp/workflows/Build%20Sphinx/badge.svg)](https://intelpython.github.io/dpnp)
 
-# DPNP: NumPy-like API accelerated with SYCL
+# DPNP: NumPy Drop-In Replacement for Intel(R) XPU
 [API coverage summary](https://intelpython.github.io/dpnp/reference/comparison.html#summary)
 
 [Full documentation](https://intelpython.github.io/dpnp/)

conda-recipe/activate_env.sh

@@ -3,9 +3,9 @@
 # if ONEAPI_ROOT is specified (use all from it)
 if [ -n "${ONEAPI_ROOT}" ]; then
     export DPCPPROOT=${ONEAPI_ROOT}/compiler/latest
-    # TODO uncomment when CI will be changed
-    # export MKLROOT=${ONEAPI_ROOT}/mkl/latest
+    export MKLROOT=${ONEAPI_ROOT}/mkl/latest
     export TBBROOT=${ONEAPI_ROOT}/tbb/latest
+    export DPLROOT=${ONEAPI_ROOT}/dpl/latest
 fi
 
 # if DPCPPROOT is specified (work with custom DPCPP)

conda-recipe/build.sh

@@ -8,19 +8,18 @@ requirements:
     host:
       - python
       - setuptools
-      - numpy >=1.15                    # [win or osx or py>=38]
-      - numpy 1.17                      # [linux and py==37]
+      - numpy 1.19.5
       - cython
-      - cmake >=3.16.5
-      - dpctl >=0.5.0a0
+      - cmake 3.19
+      - dpctl >=0.10
       - mkl-devel-dpcpp
       - tbb-devel
       - wheel
     build:
       - {{ compiler('dpcpp') }}
     run:
       - python
-      - dpctl >=0.5.0a0
+      - dpctl >=0.10
       - dpcpp_cpp_rt >=2021.1.1
       - mkl >=2021.1.1
       - mkl-dpcpp >=2021.1.1
@@ -30,10 +29,11 @@ build:
     number: {{ GIT_DESCRIBE_NUMBER }}
     include_recipe: False
     script_env:
-      - _ONEAPI_ROOT # renamed for ignore in CI
-      - _DPCPPROOT # renamed for ignore in CI
+      - ONEAPI_ROOT
+      - DPCPPROOT
       - MKLROOT
       - TBBROOT
+      - DPLROOT
       - WHEELS_OUTPUT_FOLDER
 
 test:

conda-recipe/meta.yaml

@@ -3,9 +3,9 @@
 # if ONEAPI_ROOT is specified (use all from it)
 if [ -n "${ONEAPI_ROOT}" ]; then
     export DPCPPROOT=${ONEAPI_ROOT}/compiler/latest
-    # TODO uncomment when CI will be changed
-    # export MKLROOT=${ONEAPI_ROOT}/mkl/latest
+    export MKLROOT=${ONEAPI_ROOT}/mkl/latest
     export TBBROOT=${ONEAPI_ROOT}/tbb/latest
+    export DPLROOT=${ONEAPI_ROOT}/dpl/latest
 fi
 
 # if DPCPPROOT is specified (work with custom DPCPP)

conda-recipe/run_test.sh

@@ -31,9 +31,9 @@
 author = 'Intel'
 
 # The short X.Y version
-version = '0.8'
+version = '0.9'
 # The full version, including alpha/beta/rc tags
-release = '0.8.0'
+release = '0.9.0'
 
 
 # -- General configuration ---------------------------------------------------

doc/conf.py

@@ -40,7 +40,10 @@
 if "numpy" in sys.modules:
     warnings.warn("\nDPNP: Module NumPy found. Please load DPNP module before NumPy.\n")
 
-from dpnp.dparray import dparray as ndarray
+# from dpnp.dparray import dparray as ndarray
+from dpnp.dpnp_array import dpnp_array as ndarray
+from dpnp.dpnp_flatiter import flatiter as flatiter
+
 from dpnp.dpnp_iface import *
 from dpnp.dpnp_iface import __all__ as _iface__all__
 from dpnp.dpnp_iface_types import *

dpnp/__init__.py

@@ -27,8 +27,8 @@
 
 cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
 
-# set(DPNP_VERSION 0.8.0)
-# set(DPNP_API_VERSION 0.8)
+# set(DPNP_VERSION 0.9.0)
+# set(DPNP_API_VERSION 0.9)
 
 # set directory where the custom finders live
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules")
@@ -38,14 +38,6 @@ set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/Modules")
 # -----------------------------------------------------------------------------------------------
 if(DEFINED ENV{ONEAPI_ROOT})
   set(DPNP_ONEAPI_ROOT "$ENV{ONEAPI_ROOT}" CACHE PATH "Folder contains oneapi tool set")
-else()
-  if(UNIX)
-    set(DPNP_ONEAPI_ROOT "/opt/intel/oneapi" CACHE PATH "Folder contains oneapi tool set")
-  elseif(WIN32)
-    set(DPNP_ONEAPI_ROOT "C:/Program Files (x86)/Intel/oneAPI" CACHE PATH "Folder contains oneapi tool set")
-  else()
-    message(FATAL_ERROR "Unsupported system ${CMAKE_SYSTEM}")
-  endif()
 endif()
 
 option(DPNP_STATIC_LIB_ENABLE "Enable build DPNP static library" FALSE)
@@ -253,8 +245,8 @@ target_link_libraries(dpnp_backend_c PUBLIC ${DPNP_MATHLIB_DEP_LIBS})
 
 # Parallel STL from DPC++
 if(NOT WIN32)
-  find_package(PSTL REQUIRED)
-  target_include_directories(dpnp_backend_c PUBLIC ${PSTL_INCLUDE_DIR})
+  find_package(DPL REQUIRED)
+  target_include_directories(dpnp_backend_c PUBLIC ${DPL_INCLUDE_DIR})
 endif()
 
 # SYCL queue manager

dpnp/backend/CMakeLists.txt

@@ -24,27 +24,30 @@
 # *****************************************************************************
 
 # The following variables are optionally searched for defaults
-#  PSTL_ROOT_DIR:     Base directory where all components are found
+#  DPLROOT:         Environment variable to specify custom search place
+#  ONEAPI_ROOT:     Environment variable to specify search place from oneAPI
 #
 # The following are set after configuration is done:
-#  PSTL_FOUND
-#  PSTL_INCLUDE_DIR
+#  DPL_FOUND
+#  DPL_INCLUDE_DIR
 
 include(FindPackageHandleStandardArgs)
 
-set(PSTL_ROOT_DIR
-    "${DPNP_ONEAPI_ROOT}/dpl"
-    CACHE PATH "Folder contains PSTL headers")
+set(DPNP_ONEAPI_DPL "$ENV{DPNP_ONEAPI_ROOT}/dpl/latest" CACHE PATH "Folder contains DPL files from ONEAPI_ROOT")
+
+if(DEFINED ENV{DPLROOT})
+  set(DPNP_DPLROOT "$ENV{DPLROOT}" CACHE PATH "Folder contains DPL files from DPLROOT")
+endif()
 
 find_path(
-  PSTL_INCLUDE_DIR oneapi/dpl/algorithm
-  HINTS ENV CONDA_PREFIX ${PSTL_ROOT_DIR} # search order is important
-  PATH_SUFFIXES include latest/linux/include
-  DOC "Path to PSTL include files")
+  DPL_INCLUDE_DIR oneapi/dpl/algorithm
+  HINTS ${DPNP_DPLROOT} ${DPNP_ONEAPI_DPL} ENV CONDA_PREFIX ENV PREFIX # search order is important
+  PATH_SUFFIXES include linux/include
+  DOC "Path to DPL include files")
 
-find_package_handle_standard_args(PSTL DEFAULT_MSG PSTL_INCLUDE_DIR)
+find_package_handle_standard_args(DPL DEFAULT_MSG DPL_INCLUDE_DIR)
 
-if(PSTL_FOUND)
-  message(STATUS "Found PSTL:                      (include: ${PSTL_INCLUDE_DIR})")
-  # mark_as_advanced(PSTL_ROOT_DIR PSTL_INCLUDE_DIR)
+if(DPL_FOUND)
+  message(STATUS "Found DPL:                       (include: ${DPL_INCLUDE_DIR})")
+  # mark_as_advanced(DPNP_DPLROOT DPL_INCLUDE_DIR)
 endif()

dpnp/backend/cmake/Modules/FindPSTL.cmake renamed to dpnp/backend/cmake/Modules/FindDPL.cmake

@@ -24,7 +24,8 @@
 # *****************************************************************************
 
 # The following variables are optionally searched for defaults
-#  MATHLIB_ROOT_DIR:     Base directory where all components are found
+#  MKLROOT:         Environment variable to specify custom search place
+#  ONEAPI_ROOT:     Environment variable to specify search place from oneAPI
 #
 # The following are set after configuration is done:
 #  MATHLIB_FOUND
@@ -33,9 +34,11 @@
 
 include(FindPackageHandleStandardArgs)
 
-set(MATHLIB_ROOT_DIR
-    "${DPNP_ONEAPI_ROOT}/mkl"
-    CACHE PATH "Folder contains mathlib")
+set(DPNP_ONEAPI_MKL "$ENV{DPNP_ONEAPI_ROOT}/mkl/latest" CACHE PATH "Folder contains Math Lib files from ONEAPI_ROOT")
+
+if(DEFINED ENV{MKLROOT})
+  set(DPNP_MKLROOT "$ENV{MKLROOT}" CACHE PATH "Folder contains Math Lib files from MKLROOT")
+endif()
 
 if(UNIX)
   set(MATHLIB_SYCL_LIB
@@ -51,14 +54,14 @@ endif()
 
 find_path(
   MATHLIB_INCLUDE_DIR oneapi/mkl.hpp
-  HINTS ENV CONDA_PREFIX ENV PREFIX ${MATHLIB_ROOT_DIR} # search order is important
-  PATH_SUFFIXES include latest/include
+  HINTS ${DPNP_MKLROOT} ${DPNP_ONEAPI_MKL} ENV CONDA_PREFIX ENV PREFIX # search order is important
+  PATH_SUFFIXES include include
   DOC "Path to mathlib include files")
 
 find_path(
   MATHLIB_LIBRARY_DIR ${MATHLIB_SYCL_LIB}
-  HINTS ENV CONDA_PREFIX ENV PREFIX ${MATHLIB_ROOT_DIR} # search order is important
-  PATH_SUFFIXES lib latest/lib/intel64
+  HINTS ${DPNP_MKLROOT} ${DPNP_ONEAPI_MKL} ENV CONDA_PREFIX ENV PREFIX # search order is important
+  PATH_SUFFIXES lib lib/intel64
   DOC "Path to mathlib library files")
 
 # TODO implement recurcive searching file (GLOB_RECURSE MY_PATH "/opt/intel/*/mkl.hpp")
@@ -68,5 +71,5 @@ find_package_handle_standard_args(MathLib DEFAULT_MSG MATHLIB_INCLUDE_DIR MATHLI
 
 if(MathLib_FOUND)
   message(STATUS "Found MathLib:                   (include: ${MATHLIB_INCLUDE_DIR}, library: ${MATHLIB_LIBRARY_DIR})")
-  mark_as_advanced(MATHLIB_ROOT_DIR MATHLIB_INCLUDE_DIR MATHLIB_LIBRARY_DIR)
+  # mark_as_advanced(DPNP_MKLROOT MATHLIB_INCLUDE_DIR MATHLIB_LIBRARY_DIR)
 endif()

dpnp/backend/cmake/Modules/FindMathLib.cmake

@@ -38,7 +38,7 @@ PROJECT_NAME           = "DPNP C++ backend kernel library"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.8.0
+PROJECT_NUMBER         = 0.9.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

dpnp/backend/doc/Doxyfile

@@ -84,7 +84,7 @@ cl::sycl::event dot(cl::sycl::queue& queue,
                     size_t input1_strides,
                     size_t input2_strides,
                     size_t size,
-                    const cl::sycl::vector_class<cl::sycl::event>& dependencies = {})
+                    const std::vector<cl::sycl::event>& dependencies = {})
 {
     (void)dependencies;
 
@@ -326,9 +326,7 @@ void dpnp_dot_c(void* result_out,
         }
     }
 
-    // deprecated? can be replaced with std::vector<cl::sycl::event>
-    cl::sycl::vector_class<cl::sycl::event> dot_events;
-    // std::vector<cl::sycl::event> dot_events;
+    std::vector<cl::sycl::event> dot_events;
     dot_events.reserve(result_size);
 
     size_t dot_st1 = ext_input1_strides[ext_input1_ndim - 1];
@@ -407,6 +405,15 @@ void dpnp_eig_c(const void* array_in, void* result1, void* result2, size_t size)
     const std::int64_t scratchpad_size = mkl_lapack::syevd_scratchpad_size<double>(
         DPNP_QUEUE, oneapi::mkl::job::vec, oneapi::mkl::uplo::upper, size, lda);
 
+    // https://github.com/IntelPython/dpnp/issues/1005
+    // Test tests/test_linalg.py::test_eig_arange raises 2 issues in dpnp_eig_c on CPU
+    // 1. Call of mkl_lapack::syevd_scratchpad_size<double> returns wrong value that causes out of memory issue.
+    // 2. Call of the function oneapi::mkl::lapack::syevd causes segfault.
+    // Example of the command to reproduce the issues:
+    // SYCL_DEVICE_FILTER=cpu pytest tests/test_linalg.py::test_eig_arange[2-float64]
+    // High-level reason of the issues is numpy is imported before dpnp in third party tests.
+    // Low-level reason of the issues could be related to MKL runtime library loaded during numpy import.
+
     double* scratchpad = reinterpret_cast<double*>(dpnp_memory_alloc_c(scratchpad_size * sizeof(double)));
 
     event = mkl_lapack::syevd(DPNP_QUEUE,               // queue
@@ -564,9 +571,9 @@ void dpnp_matmul_c(void* result_out,
     }
 
     cl::sycl::event event;
-    DPNPC_ptr_adapter<_DataType> input1_ptr(input1_in, size_m * size_k, true);
-    DPNPC_ptr_adapter<_DataType> input2_ptr(input2_in, size_k * size_n, true);
-    DPNPC_ptr_adapter<_DataType> result_ptr(result_out, size_m * size_n, true, true);
+    DPNPC_ptr_adapter<_DataType> input1_ptr(input1_in, size_m * size_k);
+    DPNPC_ptr_adapter<_DataType> input2_ptr(input2_in, size_k * size_n);
+    DPNPC_ptr_adapter<_DataType> result_ptr(result_out, size_m * size_n, false, true);
     _DataType* array_1 = input1_ptr.get_ptr();
     _DataType* array_2 = input2_ptr.get_ptr();
     _DataType* result = result_ptr.get_ptr();

dpnp/backend/kernels/dpnp_krnl_common.cpp

@@ -455,7 +455,7 @@ void dpnp_qr_c(void* array1_in, void* result1, void* result2, void* result3, siz
     _ComputeDT* geqrf_scratchpad =
         reinterpret_cast<_ComputeDT*>(dpnp_memory_alloc_c(geqrf_scratchpad_size * sizeof(_ComputeDT)));
 
-    cl::sycl::vector_class<cl::sycl::event> depends(1);
+    std::vector<cl::sycl::event> depends(1);
     set_barrier_event(DPNP_QUEUE, depends);
 
     event =