Skip to content

Commit 9f2f77c

Browse files
author
samaid
committed
Fixing docs
1 parent 9b9e3a6 commit 9f2f77c

File tree

2 files changed

+12
-33
lines changed

2 files changed

+12
-33
lines changed

docs/sources/benchmarks.rst

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,45 +14,27 @@ Each application/kernel is implemented in several variants (not necessarily all
1414

1515
- ``numpy``: Same application/kernel implemented using NumPy library
1616

17-
- ``dpnp``: Modified numpy implementation to run on a specific device. You can use numpy as a
18-
baseline while evaluating the dpnp implementation and its performance
17+
- ``dpnp``: Modified numpy implementation to run on a specific device. You can use numpy as a baseline while evaluating the dpnp implementation and its performance
1918

20-
- ``numba @njit`` array-style: application/kernel implemented using NumPy and compiled with Numba.
21-
You can use numpy as a baseline when evaluate numba @njit array-style implementat and its performance
19+
- ``numba @njit`` array-style: application/kernel implemented using NumPy and compiled with Numba. You can use numpy as a baseline when evaluate numba @njit array-style implementat and its performance
2220

23-
- ``numba @njit`` direct loops (prange): Same application/kernel implemented using Numba
24-
compiler using direct loops. Sometimes array-style programming is cumbersome and
25-
performance inefficient. Using direct loop programming may lead to more
26-
readable and performance code. Thus, while evaluating the performance of direct loop
27-
implementation it is useful to compare array-style Numba implementation as a baseline
21+
- ``numba @njit`` direct loops (prange): Same application/kernel implemented using Numba compiler using direct loops. Sometimes array-style programming is cumbersome and performance inefficient. Using direct loop programming may lead to more readable and performance code. Thus, while evaluating the performance of direct loop implementation it is useful to compare array-style Numba implementation as a baseline
2822

29-
- ``numba-dpex @dpjit`` array-style: Modified numba @njit array-style implementation to
30-
compile and run on a specific device. You can use vanilla Numba implementation as
31-
a baseline while comparing numba-dpex implementation details and performance.
32-
You can also compare it against dpnp implementation to see how much extra performance
33-
numba-dpex can bring when you compile NumPy code for a given device
23+
- ``numba-dpex @dpjit`` array-style: Modified numba @njit array-style implementation to compile and run on a specific device. You can use vanilla Numba implementation as a baseline while comparing numba-dpex implementation details and performance. You can also compare it against dpnp implementation to see how much extra performance numba-dpex can bring when you compile NumPy code for a given device
3424

35-
- ``numba-dpex @dpjit`` direct loops (prange): Modified numba @njit direct loop implementation
36-
to compile and run on a specific device. You can use vanilla Numba implementation
37-
as a baseline while comparing numba-dpex implementation details and performance.
38-
You can also compare it against dpnp implementation to see how much extra performance
39-
numba-dpex can bring when you compile NumPy code for a given device
25+
- ``numba-dpex @dpjit`` direct loops (prange): Modified numba @njit direct loop implementation to compile and run on a specific device. You can use vanilla Numba implementation as a baseline while comparing numba-dpex implementation details and performance. You can also compare it against dpnp implementation to see how much extra performance numba-dpex can bring when you compile NumPy code for a given device
4026

41-
- ``numba-dpex @dpjit`` kernel: Kernel-style programming, which is close to @cuda.jit
42-
programming model used in vanilla Numba
27+
- ``numba-dpex @dpjit`` kernel: Kernel-style programming, which is close to @cuda.jit programming model used in vanilla Numba
4328

44-
- ``numba-mlir``: Array-style, direct loops and kernel-style implementations
45-
for experimental MLIR-based backend for Numba
29+
- ``numba-mlir``: Array-style, direct loops and kernel-style implementations for experimental MLIR-based backend for Numba
4630

4731
- ``cupy``: NumPy-like implementation using CuPy to run on CUDA-compatible devices
4832

4933
- ``@cuda.jit``: Kernel-style Numba implementation to run on CUDA-compatible devices
5034

51-
- Native SYCL: Most applications/kernels also have DPC++ implementation, which
52-
can be used to compare performance of above implementations to DPC++ compiled code.
35+
- Native SYCL: Most applications/kernels also have DPC++ implementation, which can be used to compare performance of above implementations to DPC++ compiled code.
5336

54-
These benchmarks are implemented in ``dpbench`` framework, which allows you to run
55-
all or select benchmarks and variants to evaluate their performance on different hardware.
37+
These benchmarks are implemented in ``dpbench`` framework, which allows you to run all or select benchmarks and variants to evaluate their performance on different hardware.
5638

5739
For more details please refer to ``dpbench``
5840
`documentation <https://github.com/IntelPython/dpbench/blob/main/README.md>`_.

docs/sources/demos.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,11 @@ Demos
66

77
There are several demo applications illustrating the power of the **Data Parallel Extensions for Python**. They are:
88

9-
- `Monte Carlo Pi <https://github.com/IntelPython/DPEP/tree/main/demos/mcpi>`_ -
10-
The Monte Carlo method to estimate the value of :math:`\pi`.
9+
- `Monte Carlo Pi <https://github.com/IntelPython/DPEP/tree/main/demos/mcpi>`_ - The Monte Carlo method to estimate the value of :math:`\pi`.
1110

12-
- `Mandelbrot Set <https://github.com/IntelPython/DPEP/tree/main/demos/mandelbrot>`_ -
13-
Visualization of the breathtaking process of diving in the famous Mandelbrot fractal
11+
- `Mandelbrot Set <https://github.com/IntelPython/DPEP/tree/main/demos/mandelbrot>`_ - Visualization of the breathtaking process of diving in the famous Mandelbrot fractal
1412

15-
- `Game of Life <https://github.com/IntelPython/DPEP/tree/main/demos/game-of-life>`_ -
16-
Visualization of the life evolution using famous Conway's model
13+
- `Game of Life <https://github.com/IntelPython/DPEP/tree/main/demos/game-of-life>`_ - Visualization of the life evolution using famous Conway's model
1714

1815
All demos are located in the `GitHub repository <https://github.com/IntelPython/DPEP/tree/main/demos>`_.
1916
For more details please refer to the documentation located in the individual demo directory.

0 commit comments

Comments
 (0)