IntelPython · diptorupd · Mar 1, 2021 · Mar 1, 2021 · Mar 2, 2021 · Feb 15, 2021
@@ -5,9 +5,8 @@ name: black
 # Controls when the action will run. Triggers the workflow on push or pull request
 # events but only for the master branch
 on:
-  push:
-    branches: [master]
   pull_request:
+  push:
     branches: [master]
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel

@@ -5,9 +5,8 @@ name: clang-format Check
 # Controls when the action will run. Triggers the workflow on push or pull request
 # events but only for the master branch
 on:
-  push:
-    branches: [master]
   pull_request:
+  push:
     branches: [master]
 
 jobs:

@@ -8,6 +8,7 @@ __pycache__/
 *.so
 *.exe
 *.lib
+*.dll
 
 # CMake build and local install directory
 build

@@ -4,19 +4,38 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-
 ## [Unreleased]
+
+## [0.6.1] - 2021-03-01
+### Fixed
+- Do not use POP_FRONT in FindDPCPP.cmake so that we can use a cmake version older that 3.15.
+
+## [0.6.0] - 2021-03-01
 ### Added
-- Documentation improvements
-- Cmake improvements and Coverage for C API, Cython and Python
-- Added support for Level Zero devices and queues
-- Added support for SYCL standard device_selector classes
-- SyclDevice instances can now be constructed using filter selector strings
-- Code of conduct
+- Documentation improvements.
+- Cmake improvements and Coverage for C API, Cython and Python.
+- Added support for Level Zero devices and queues.
+- Added support for SYCL standard device_selector classes.
+- SyclDevice instances can now be constructed using filter selector strings.
+- Code of conduct.
+- Building wheels.
+- Queue manager improvements.
+- Adding `__array_function__` so that Numpy calls with dparrays work.
+- Using clang-format for C/C++ code formatting.
+- Using pytest for running tests.
+- Add python and cython file coverage.
+- Using Bandit for finding common security issues in Python code.
+- Add instructions about file headers formats.
+
+### Changed
+- Changed compiler name usage from clang++ to dpcpp.
+- Reformat backend.pxd to be closer to black style.
 
 ### Fixed
 - Remove `cython` from `install_requires`. It allows use `dpCtl` in `numba` extensions.
 - Incorrect import in example.
+- Consistency of file headers.
+- Klocwork issues.
 
 ## [0.5.0] - 2020-12-17
 ### Added

@@ -9,7 +9,7 @@ We use [clang-format](https://clang.llvm.org/docs/ClangFormat.html) code formatt
 Install: `conda install clang-tools`
 
 - Revision: `10.0.1`
-- See the default configuration used by dpCtl in `.clang-format`.
+- See the default configuration used by dpctl in `.clang-format`.
 
 Run before each commit: `clang-format -style=file -i dpctl-capi/include/*.h dpctl-capi/include/Support/*.h dpctl-capi/source/*.cpp dpctl-capi/tests/*.cpp dpctl-capi/helper/include/*.h dpctl-capi/helper/source/*.cpp`
 
@@ -30,7 +30,7 @@ purpose of the file. The standard header looks like this:
 ```
 //===----- dpctl_sycl_event_interface.h - C API for sycl::event  -*-C++-*- ===//
 //
-//                      Data Parallel Control (dpCtl)
+//                      Data Parallel Control (dpctl)
 //
 // Copyright 2020-2021 Intel Corporation
 //
@@ -69,7 +69,7 @@ Few things to note about this format:
 Every Python and Cython file should only include the following license header:
 
 ```
-#                      Data Parallel Control (dpCtl)
+#                      Data Parallel Control (dpctl)
 #
 # Copyright 2020-2021 Intel Corporation
 #

@@ -1,6 +1,6 @@
 include versioneer.py
 recursive-include dpctl/include *.h *.hpp
-include dpctl/*.pxd
+recursive-include dpctl *.pxd
 include dpctl/*DPCTL*Interface.*
 include dpctl/tests/input_files/*
 global-exclude *.cpp
@@ -41,7 +41,7 @@ conda install dpctl
 
 Build and Install with setuptools
 =================================
-dpCtl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
+dpctl relies on DPC++ runtime. With Intel oneAPI installed you should activate it.
 `setup.py` requires environment variable `ONEAPI_ROOT` and following packages
 installed:
 - `cython`
@@ -65,9 +65,28 @@ For development:
 python setup.py develop
 ```
 
-Using dpCtl
+Install Wheel Package from Pypi
+==================================
+1. Install dpctl
+```cmd
+python -m pip install --index-url https://pypi.anaconda.org/intel/simple -extra-index-url https://pypi.org/simple dpctl
+```
+Note: dpctl wheel package is placed on Pypi, but some of its dependencies (like Intel numpy) are in Anaconda Cloud.
+That is why install command requires additional intel Pypi channel from Anaconda Cloud.
+
+2. Set path to Performance Libraries in case of using venv or system Python:
+On Linux:
+```cmd
+export LD_LIBRARY_PATH=<path_to_your_env>/lib
+```
+On Windows:
+```cmd
+set PATH=<path_to_your_env>\bin;<path_to_your_env>\Library\bin;%PATH%
+```
+
+Using dpctl
 ===========
-dpCtl relies on DPC++ runtime. With Intel oneAPI installed you could activate it.
+dpctl relies on DPC++ runtime. With Intel oneAPI installed you could activate it.
 
 On Windows:
 ```cmd
@@ -78,7 +97,7 @@ On Linux:
 source ${ONEAPI_ROOT}/compiler/latest/env/vars.sh
 ```
 
-When dpCtl is installed via conda package
+When dpctl is installed via conda package
 then it uses DPC++ runtime from `dpcpp_cpp_rt` package
 and it is not necessary to activate oneAPI DPC++ compiler environment.
 
@@ -94,7 +113,7 @@ for script in `ls examples/python/`; do echo "executing ${script}"; python examp
 ```
 
 Examples of building Cython extensions with DPC++ compiler, that interoperate
-with dpCtl can be found in folder `cython`.
+with dpctl can be found in folder `cython`.
 
 Each example in `cython` folder can be built using
 `CC=clang CXX=dpcpp python setup.py build_ext --inplace`.

@@ -1,12 +1,12 @@
 call "%ONEAPI_ROOT%\compiler\latest\env\vars.bat"
-IF %ERRORLEVEL% NEQ 0 (
-	echo "oneAPI compiler activation failed"
-	exit /b 1
+if errorlevel 1 (
+    echo "oneAPI compiler activation failed"
+    exit /b 1
 )
 
 "%PYTHON%" setup.py clean --all
 "%PYTHON%" setup.py install
-IF %ERRORLEVEL% NEQ 0 exit /b 1
+if errorlevel 1 exit 1
 
 rem Build wheel package
 if NOT "%WHEELS_OUTPUT_FOLDER%"=="" (

@@ -34,7 +34,7 @@ test:
     - pytest
     - pytest-cov
 about:
-    home: https://github.com/IntelPython/dpCtl.git
+    home: https://github.com/IntelPython/dpctl.git
     license: Apache-2.0
     license_file: LICENSE
     summary: 'A lightweight Python wrapper for a subset of OpenCL and SYCL API.'

@@ -1,5 +1,5 @@
 call "%ONEAPI_ROOT%\compiler\latest\env\vars.bat"
-IF %ERRORLEVEL% NEQ 0 (
+if errorlevel 1 (
 	echo "oneAPI compiler activation failed%"
 	exit /b 1
 )
@@ -9,7 +9,7 @@ set ERRORLEVEL=
 @echo on
 
 "%PYTHON%" -c "import dpctl"
-IF %ERRORLEVEL% NEQ 0 exit /b 1
+if errorlevel 1 exit 1
 
 pytest -q -ra --disable-warnings --pyargs dpctl -vv
-IF %ERRORLEVEL% NEQ 0 exit /b 1
+if errorlevel 1 exit 1
@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
-project("Data-parallel Control (dpCtl)")
+project("Data-parallel Control (dpctl)")
 # Add the cmake folder so the FindSphinx module is found
 set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 
@@ -9,7 +9,7 @@ find_package (Git)
 
 set(DOC_OUTPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/generated_docs)
 if( DPCTL_DOCGEN_PREFIX )
-    message(STATUS "Generating dpCtl documents in " ${DPCTL_DOCGEN_PREFIX})
+    message(STATUS "Generating dpctl documents in " ${DPCTL_DOCGEN_PREFIX})
     set(DOC_OUTPUT_DIR ${DPCTL_DOCGEN_PREFIX})
 endif()
 
@@ -74,7 +74,7 @@ add_custom_command(
     COMMAND
         ${SPHINX_EXECUTABLE} -b html
         # Tell Breathe where to find the Doxygen output
-        -Dbreathe_projects.dpCtl-CAPI=${DOXYGEN_OUTPUT_DIR}/xml
+        -Dbreathe_projects.dpctl-CAPI=${DOXYGEN_OUTPUT_DIR}/xml
         ${SPHINX_SOURCE} ${SPHINX_OUTPUT_DIR}
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     DEPENDS

@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Data-parallel Control (dpCtl)"
+PROJECT_NAME           = "Data-parallel Control (dpctl)"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

@@ -1,7 +1,7 @@
 What?
 =====
 
-Generator scripts for dpCtl API documentation. To run these scripts, follow
+Generator scripts for dpctl API documentation. To run these scripts, follow
 the following steps:
 ```bash
 cd dpctl/docs
@@ -16,7 +16,7 @@ documents in the current source directory in a sub-directory called
 `generated_docs`.
 
 The `make Sphinx` command will generate standalone Doxygen documentation and
-a consolidated Sphinx documentation for both dpCtl Python and C APIs.
+a consolidated Sphinx documentation for both dpctl Python and C APIs.
 
 Prerequisite
 ============

@@ -38,7 +38,7 @@ extensions = [
 ]
 
 # Breathe Configuration
-breathe_default_project = "dpCtl-CAPI"
+breathe_default_project = "dpctl-CAPI"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -58,8 +58,8 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 exhale_args = {
     # These arguments are required
     "containmentFolder": "./api",
-    "rootFileName": "dpCtl-CAPI_root.rst",
-    "rootFileTitle": "dpCtl C API",
+    "rootFileName": "dpctl-CAPI_root.rst",
+    "rootFileTitle": "dpctl C API",
     "doxygenStripFromPath": "..",
     "createTreeView": True,
     "exhaleExecutesDoxygen": True,

@@ -1,7 +1,7 @@
 .. _dpCtl.dptensor_api:
 
 #########################
-dpCtl dptensor Python API
+dpctl dptensor Python API
 #########################
 
 .. automodule:: dpctl.dptensor

@@ -1,7 +1,7 @@
 .. _dpCtl.program_api:
 
 ########################
-dpCtl Program Python API
+dpctl Program Python API
 ########################
 
 .. automodule:: dpctl.program

@@ -1,7 +1,7 @@
 .. _dpCtl_api:
 
 ################
-dpCtl Python API
+dpctl Python API
 ################
 
 .. automodule:: dpctl
@@ -55,9 +55,7 @@ Functions
 .. autofunction:: get_include
 .. autofunction:: get_num_activated_queues
 .. autofunction:: get_num_platforms
-.. autofunction:: get_num_queues
-.. autofunction:: has_cpu_queues
-.. autofunction:: has_gpu_queues
+.. autofunction:: get_num_devices
 .. autofunction:: has_sycl_platforms
 .. autofunction:: is_in_device_context
-.. autofunction:: set_default_queue
+.. autofunction:: set_global_queue
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Data-parallel Control (dpCtl)'s documentation!
+Welcome to Data-parallel Control (dpctl)'s documentation!
 =========================================================
 
 .. toctree::

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.10 FATAL_ERROR)
-project("dpCtl C API - A C wrapper for a subset of SYCL")
+project("dpctl C API - A C wrapper for a subset of SYCL")
 
 # Option to turn on support for creating Level Zero interoperability programs
 # from a SPIR-V binary file.
@@ -41,7 +41,7 @@ if(WIN32)
     set(CMAKE_LINKER:PATH "${DPCPP_ROOT}/bin/lld-link")
     message(STATUS "Resetting CXX compiler to: " ${CMAKE_CXX_COMPILER})
     message(STATUS "Resetting C compiler to: " ${CMAKE_C_COMPILER})
-    message(STATUS "Resetting Linker to: " ${CMAKE_LINK})
+    message(STATUS "Resetting Linker to: " ${CMAKE_LINKER})
     set(WARNING_FLAGS "-Wall -Wextra -Winit-self -Wunused-function -Wuninitialized -Wmissing-declarations")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${WARNING_FLAGS}")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${WARNING_FLAGS} -Qstd=c++17")
@@ -108,10 +108,8 @@ if(DPCTL_ENABLE_LO_PROGRAM_CREATION)
 endif()
 
 install(
-  TARGETS
-  DPCTLSyclInterface
-  LIBRARY DESTINATION
-  "${CMAKE_INSTALL_PREFIX}/lib/"
+  TARGETS DPCTLSyclInterface
+  LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/lib/
 )
 
 # Install all headers
@@ -154,7 +152,7 @@ if(DPCTL_GENERATE_COVERAGE)
     endif()
 endif()
 
-# Add sub-directory to build the dpCtl C API test cases
+# Add sub-directory to build the dpctl C API test cases
 if(DPCTL_BUILD_CAPI_TESTS)
     add_subdirectory(tests)
 endif()
@@ -1,4 +1,4 @@
-#                       Data Parallel Control (dpCtl)
+#                       Data Parallel Control (dpctl)
 #
 # Copyright 2020-2021 Intel Corporation
 #
@@ -100,12 +100,14 @@ if(${dpcpp_result} MATCHES "0")
         set(DPCPP_SYCL_LIBRARY ${DPCPP_INSTALL_DIR}/lib/libsycl.so)
         set(DPCPP_OPENCL_LIBRARY ${DPCPP_INSTALL_DIR}/lib/libOpenCL.so)
     endif()
+	set(DPCPP_FOUND TRUE)
 else()
     message(STATUS "DPCPP needed to build dpctl_sycl_interface")
     return()
 endif()
 
 find_package_handle_standard_args(DPCPP DEFAULT_MSG
+    DPCPP_FOUND
     DPCPP_VERSION
     DPCPP_INCLUDE_DIR
     DPCPP_SYCL_INCLUDE_DIR

@@ -1,4 +1,4 @@
-#                       Data Parallel Control (dpCtl)
+#                       Data Parallel Control (dpctl)
 #
 # Copyright 2020-2021 Intel Corporation
 #
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,6 +8,7 @@ __pycache__/ @@
     *.so
     *.exe
     *.lib
+    *.dll
     # CMake build and local install directory
     build
@@ Expand Down @@