Skip to content

Update README.md title extension for examples #916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 26, 2022
Merged

Update README.md title extension for examples #916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a09872d
Update README.md title extension for example
npolina4 Sep 21, 2022
c97d39c
Update README.md title extension for example
npolina4 Sep 21, 2022
4b60d45
Update README.md title extension for example
npolina4 Sep 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions examples/cython/sycl_buffer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -10,15 +10,15 @@ 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
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
Expand Down
8 changes: 4 additions & 4 deletions examples/cython/usm_memory/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions examples/pybind11/onemkl_gemv/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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" \
Expand All @@ -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
Expand Down