Skip to content

Commit ecec512

Browse files
Merge pull request #916 from IntelPython/fix_examples_readme
2 parents f56bd7a + 4b60d45 commit ecec512

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

examples/cython/sycl_buffer/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
#1 Example of SYCL extension working NumPy array input via SYCL buffers
1+
# Example of SYCL extension working NumPy array input via SYCL buffers
22

33

4-
#2 Decription
4+
## Decription
55

66
Cython function expecting a 2D array in C-contiguous layout that
77
computes column-wise total by using SYCL oneMKL (as GEMV call with
@@ -10,15 +10,15 @@ an all units vector).
1010
Example illustrates compiling SYCL extension, linking to oneMKL.
1111

1212

13-
#2 Compiling
13+
## Compiling
1414

1515
```
1616
# make sure oneAPI is activated, $ONEAPI_ROOT must be set
1717
CC=icx CXX=dpcpp python setup.py build_ext --inplace
1818
```
1919

2020

21-
#2 Running
21+
## Running
2222

2323
```
2424
# SYCL_DEVICE_FILTER=opencl sets SYCL backend to OpenCL to avoid a

examples/cython/usm_memory/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
#1 Example of working with USM memory
1+
# Example of working with USM memory
22

3-
#2 Description
3+
## Description
44

5-
#2 Building
5+
## Building
66

77
Make sure oneAPI is activated. Environment variable `$ONEAPI_ROOT` must be set.
88

@@ -12,7 +12,7 @@ $ CC=icx CXX=dpcpp LD_SHARED="dpcpp -shared" \
1212
CXXFLAGS=-fno-sycl-early-optimizations python setup.py build_ext --inplace
1313
```
1414

15-
#2 Running
15+
## Running
1616

1717
```
1818
$ python run.py

examples/pybind11/onemkl_gemv/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Example of SYCL built pybind11 extension
1+
# Example of SYCL built pybind11 extension
22

3-
To build, use (assumes scikit-build and dpcpp is installed):
3+
## To build, use (assumes scikit-build and dpcpp is installed):
44

55
```sh
66
python setup.py develop -- -G "Ninja" \
@@ -12,13 +12,13 @@ python setup.py develop -- -G "Ninja" \
1212
-DTBB_INCLUDE_DIR=${CONDA_PREFIX}/include
1313
```
1414

15-
To run test suite
15+
## To run test suite
1616

1717
```sh
1818
python -m pytest tests
1919
```
2020

21-
To compare Python overhead,
21+
## To compare Python overhead,
2222

2323
```
2424
# build standad-alone executable

0 commit comments

Comments
 (0)