Skip to content

Commit 5bc3c4d

Browse files
Cleaned up root README.md file
1 parent 9e1806c commit 5bc3c4d

File tree

1 file changed

+18
-22
lines changed

1 file changed

+18
-22
lines changed

README.md

+18-22
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The compute kernel can be a code:
1919
* that is part of a library, such as oneMKL
2020

2121
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
2323
bindings for a subset of the standard [runtime
2424
classes](https://www.khronos.org/registry/SYCL/specs/sycl-2020/html/sycl-2020.html#_sycl_runtime_classes) that allow users to:
2525
* query platforms
@@ -57,7 +57,7 @@ To get the library from the latest oneAPI release, follow the
5757
instructions from Intel(R) [oneAPI installation
5858
guide](https://www.intel.com/content/www/us/en/developer/articles/guide/installation-guide-for-oneapi-toolkits.html).
5959

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
6161
>IDP and `dpctl`.
6262
6363

@@ -85,42 +85,38 @@ To try out the current master, install it from our
8585
development channel on Anaconda cloud:
8686

8787
```bash
88-
conda install dpctl -c dppy\label\dev
88+
conda install dpctl -c dppy/label/dev
8989
```
9090

9191
# Building
9292

9393
Refer to our [Documentation](https://intelpython.github.io/dpctl) for more information on
9494
setting up a development environment and building `dpctl` from the source.
9595

96-
# Running Examples
9796

98-
Find our examples [here](examples).
97+
# Examples
9998

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.
101103

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.
112107

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.
118108

119109
# Running Tests
120110

121-
Tests are located [here](dpctl/tests).
111+
Tests are located in folder [dpctl/tests](dpctl/tests).
122112

123113
To run the tests, use:
124114
```bash
125115
pytest --pyargs dpctl
126116
```
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

Comments
 (0)