diff --git a/examples/cython/sycl_buffer/README.md b/examples/cython/sycl_buffer/README.md index f02b58d1c3..a78df825c4 100644 --- a/examples/cython/sycl_buffer/README.md +++ b/examples/cython/sycl_buffer/README.md @@ -1,7 +1,7 @@ -#1 Example of SYCL extension working NumPy array input via SYCL buffers +# Example of SYCL extension working NumPy array input via SYCL buffers -#2 Decription +## Decription Cython function expecting a 2D array in C-contiguous layout that computes column-wise total by using SYCL oneMKL (as GEMV call with @@ -10,7 +10,7 @@ an all units vector). Example illustrates compiling SYCL extension, linking to oneMKL. -#2 Compiling +## Compiling ``` # make sure oneAPI is activated, $ONEAPI_ROOT must be set @@ -18,7 +18,7 @@ CC=icx CXX=dpcpp python setup.py build_ext --inplace ``` -#2 Running +## Running ``` # SYCL_DEVICE_FILTER=opencl sets SYCL backend to OpenCL to avoid a diff --git a/examples/cython/usm_memory/README.md b/examples/cython/usm_memory/README.md index 300e4464a8..bab69c6f99 100644 --- a/examples/cython/usm_memory/README.md +++ b/examples/cython/usm_memory/README.md @@ -1,8 +1,8 @@ -#1 Example of working with USM memory +# Example of working with USM memory -#2 Description +## Description -#2 Building +## Building Make sure oneAPI is activated. Environment variable `$ONEAPI_ROOT` must be set. @@ -12,7 +12,7 @@ $ CC=icx CXX=dpcpp LD_SHARED="dpcpp -shared" \ CXXFLAGS=-fno-sycl-early-optimizations python setup.py build_ext --inplace ``` -#2 Running +## Running ``` $ python run.py diff --git a/examples/pybind11/onemkl_gemv/README.md b/examples/pybind11/onemkl_gemv/README.md index e984a5e013..614f3e0068 100644 --- a/examples/pybind11/onemkl_gemv/README.md +++ b/examples/pybind11/onemkl_gemv/README.md @@ -1,6 +1,6 @@ -Example of SYCL built pybind11 extension +# Example of SYCL built pybind11 extension -To build, use (assumes scikit-build and dpcpp is installed): +## To build, use (assumes scikit-build and dpcpp is installed): ```sh python setup.py develop -- -G "Ninja" \ @@ -12,13 +12,13 @@ python setup.py develop -- -G "Ninja" \ -DTBB_INCLUDE_DIR=${CONDA_PREFIX}/include ``` -To run test suite +## To run test suite ```sh python -m pytest tests ``` -To compare Python overhead, +## To compare Python overhead, ``` # build standad-alone executable