Skip to content
This repository was archived by the owner on Jan 25, 2023. It is now read-only.

Commit 7c22278

Browse files
committed
Update README.md with info from Numba-PyDPPL
Moved related topics from README.rst for Numba-PyDPPL.
1 parent 147f7f1 commit 7c22278

File tree

1 file changed

+49
-5
lines changed

1 file changed

+49
-5
lines changed

README.md

Lines changed: 49 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# numba-dppy
22

3-
## Numba + dpCtl + dpNP = numba-dppy
3+
## Numba + dpPy + dpCtl + dpNP = numba-dppy
44

55
`numba-dppy` extends Numba with new backend for support compilation
66
for Intel CPU and GPU architectures.
77

88
For more information about Numba, see the Numba homepage:
9-
http://numba.pydata.org
9+
http://numba.pydata.org.
10+
11+
Note: `numba-dppy` requires patched version of Numba.
12+
See https://github.com/IntelPython/numba.
1013

1114
For more information about dpCtl, see the dpCtl homepage:
1215
https://intelpython.github.io/dpctl/
@@ -16,6 +19,47 @@ https://intelpython.github.io/dpnp/
1619

1720
## Dependencies
1821

19-
* numba
20-
* dpCtl
21-
* dpNP (optional)
22+
* numba >=0.51 (IntelPython/numba)
23+
* dpCtl >=0.3.8
24+
* dpNP >=0.3 (optional)
25+
* llvm-spirv (SPIRV generation from LLVM IR)
26+
* llvmdev (LLVM IR generation)
27+
* spirv-tools
28+
29+
## dpPy
30+
31+
dpPy is a proof-of-concept backend for NUMBA to support compilation for
32+
Intel CPU and GPU architectures.
33+
The present implementation of dpPy is based on OpenCL 2.1, but is likely
34+
to change in the future to rely on Sycl/DPC++ or Intel Level-0 driver API.
35+
36+
## Installation
37+
38+
Use setup.py or conda (see conda-recipe).
39+
40+
## Testing
41+
42+
See folder `numba_dppy/tests`.
43+
44+
Run tests:
45+
```bash
46+
python -m numba.runtests numba_dppy.tests
47+
```
48+
49+
## Examples
50+
51+
See folder `numba_dppy/examples`.
52+
53+
Run examples:
54+
```bash
55+
python numba_dppy/examples/sum.py
56+
```
57+
58+
## How Tos
59+
60+
Refer the HowTo.rst guide for an overview of the programming semantics,
61+
examples, supported functionalities, and known issues.
62+
63+
## Reporting issues
64+
65+
Please use https://github.com/IntelPython/numba-dppy/issues to report issues and bugs.

0 commit comments

Comments
 (0)