@@ -19,7 +19,7 @@ The compute kernel can be a code:
19
19
* that is part of a library, such as oneMKL
20
20
21
21
The ` dpctl ` library is built upon the [ SYCL
22
- standard] ( https://www.khronos.org/sycl/ ) . It also implements Python
22
+ standard] ( https://www.khronos.org/sycl/ ) . It implements Python
23
23
bindings for a subset of the standard [ runtime
24
24
classes] ( https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes ) that allow users to:
25
25
* query platforms
@@ -57,7 +57,7 @@ To get the library from the latest oneAPI release, follow the
57
57
instructions from Intel(R) [ oneAPI installation
58
58
guide] ( https://www.intel.com/content/www/us/en/developer/articles/guide/installation-guide-for-oneapi-toolkits.html ) .
59
59
60
- > ** NOTE:** You need to install the Intel(R) oneAPI Basekit to get
60
+ > ** NOTE:** You need to install the Intel(R) oneAPI AI Analytics Tookit to get
61
61
> IDP and ` dpctl ` .
62
62
63
63
@@ -85,42 +85,38 @@ To try out the current master, install it from our
85
85
development channel on Anaconda cloud:
86
86
87
87
``` bash
88
- conda install dpctl -c dppy\ l abel\ d ev
88
+ conda install dpctl -c dppy/ label/ dev
89
89
```
90
90
91
91
# Building
92
92
93
93
Refer to our [ Documentation] ( https://intelpython.github.io/dpctl ) for more information on
94
94
setting up a development environment and building ` dpctl ` from the source.
95
95
96
- # Running Examples
97
96
98
- Find our examples [ here ] ( examples ) .
97
+ # Examples
99
98
100
- To run these examples, use:
99
+ Our examples are located in the [ examples/] ( examples ) folder and are organized in folders. Examples
100
+ in the [ Python/] ( examples/python ) folder demonstrate how to inspect the heterogeneous platform,
101
+ select a device, create an execution queue, and how to control device memory allocation and
102
+ execution placement.
101
103
102
- ``` bash
103
- for script in ` ls examples/python/` ;
104
- do echo " executing ${script} " ;
105
- python examples/python/${script} ;
106
- done
107
- ```
108
-
109
- ## Cython extensions
110
- See examples of building Cython extensions with DPC++ compiler that interoperates
111
- with ` dpctl ` in the [ cython folder] ( examples\cython ) .
104
+ Examples in [ Cython/] ( examples/cython ) , [ C/] ( examples/c ) , and [ Pybind11] ( examples/pybind11 ) folders
105
+ demonstrate creation of SYCL-powered native Python extensions. Please refer to each folder's README
106
+ document for directions on how to build and use each example.
112
107
113
- To build these examples, run:
114
- ``` bash
115
- CC=icx CXX=dpcpp python setup.py build_ext --inplace
116
- ```
117
- To execute extensions, refer to the ` run.py ` script in each folder.
118
108
119
109
# Running Tests
120
110
121
- Tests are located [ here ] ( dpctl/tests ) .
111
+ Tests are located in folder [ dpctl/tests ] ( dpctl/tests ) .
122
112
123
113
To run the tests, use:
124
114
``` bash
125
115
pytest --pyargs dpctl
126
116
```
117
+
118
+ Running full test suite requires working C++ compiler. To run the test suite without one, use:
119
+
120
+ ``` bash
121
+ pytest --pyargs dpctl -k " not test_cython_api"
122
+ ```
0 commit comments