Skip to content

Commit 3cca4f8

Browse files
committed
Final changes
1 parent 64a7f67 commit 3cca4f8

File tree

15 files changed

+108
-109
lines changed

15 files changed

+108
-109
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ of `dpctl`
1818
- [Python Code Style](#python-code-style)
1919
- [Setting Up a Pre-commit](#setting-up-a-pre-commit)
2020
- [C/C++ File Headers](#cc-file-headers)
21-
- [Python* File Headers](#python-file-headers)
21+
- [Python File Headers](#python-file-headers)
2222
- [Security](#security)
2323
- [Bandit](#bandit)
2424
- [Code Coverage](#code-coverage)
2525
- [Error Reporting and Logging](#error-reporting-and-logging)
26-
- [Optional use of the Google* logging library (glog*)](#optional-use-of-the-google-logging-library-glog)
26+
- [Optional use of the Google logging library (glog)](#optional-use-of-the-google-logging-library-glog)
2727

2828

2929
# Mechanical Source Issues
@@ -53,7 +53,7 @@ clang-format -style=file -i \
5353
libsyclinterface/helper/source/*.cpp
5454
```
5555

56-
> **:** It is easier to use `pre-commit` and the `clang-format` hook.
56+
> **NOTE:** It is recommended to use `pre-commit` that invokes `clang-format` among other linters as configured.
5757
5858
### Python Code Style
5959

@@ -116,7 +116,7 @@ The standard header looks like this:
116116
> **NOTE:**
117117
>- The `-*- C++ -*-` string on the first line tells Emacs* that
118118
it is a C++ file. The string is only needed for `*.h` headers and
119-
should be omitted for `*.cpp` files. Without the string, Emacs* assumes the
119+
should be omitted for `*.cpp` files. Without the string, Emacs assumes the
120120
file is a C header.
121121
>- The copyright year must be updated every calendar year.
122122
>- Each comment line should be a max of 80 chars.
@@ -128,9 +128,9 @@ The standard header looks like this:
128128
---
129129

130130

131-
### Python* File Headers
131+
### Python File Headers
132132

133-
Every Python* and Cython* file should only include the following license header:
133+
Every Python and Cython file should only include the following license header:
134134

135135
```
136136
# Data Parallel Control (dpctl)
@@ -156,8 +156,8 @@ The copyright year should be updated every calendar year.
156156

157157
### Bandit
158158

159-
We use [Bandit*](https://github.com/PyCQA/bandit) to find common security issues
160-
in the Python* code.
159+
We use [Bandit](https://github.com/PyCQA/bandit) to find common security issues
160+
in the Python code.
161161

162162
To install, run:
163163
```bash
@@ -182,15 +182,14 @@ To check the code coverage for your code, follow these steps:
182182

183183
1. Install dependencies for C/C++ source.
184184

185-
For C/C++ source, we require `lcov`, `llvm-cov`, and `llvm-profdata`. `llvm-cov` and `llvm-profdata`
186-
should be version 11.0 or higher. If you
185+
For C/C++ source, `lcov`, `llvm-cov` (>=11.0), and `llvm-profdata` (>=11.0) are required. If you
187186
have multiple `llvm-cov` tools installed, set the `LLVM_TOOLS_HOME`
188187
environment variable to make sure the correct one is used to generate
189188
coverage.
190189

191-
2. Install dependencies for Python* sources.
190+
2. Install dependencies for Python sources.
192191

193-
To generate the coverage data for dpctl Python* sources,
192+
To generate the coverage data for dpctl Python sources,
194193
install `coverage`:
195194

196195
```bash
@@ -208,10 +207,10 @@ To check the code coverage for your code, follow these steps:
208207
reason, the coverage script builds the package in `develop` mode of
209208
`setup.py`.
210209

211-
The coverage results for the C and Python* sources are printed to the
212-
terminal during the build (`libsyclinterface`) and pytest execution (Python*).
210+
The coverage results for the C and Python sources are printed to the
211+
terminal during the build (`libsyclinterface`) and pytest execution (Python).
213212
The detailed coverage reports for the `libsyclinterface` library are saved to the
214-
`dpctl-c-api-coverage` directory. The Python* coverage reports are saved to
213+
`dpctl-c-api-coverage` directory. The Python coverage reports are saved to
215214
the `htmlcov` directory.
216215

217216
The coverage data for every PR is also available online at
@@ -241,24 +240,24 @@ export DPCTL_VERBOSITY=warning
241240

242241
Messages of a given severity are shown not only in the console for that severity but also for the higher severity. For example, the severity level `warning` outputs severity errors for `error` and `warning` to the console.
243242

244-
### Optional use of the Google* logging library (glog*)
243+
### Optional use of the Google logging library (glog)
245244

246-
The dpctl error handler for libsyclinterface can be optionally configured to use [glog*](https://github.com/google/glog).
245+
The dpctl error handler for libsyclinterface can be optionally configured to use [glog](https://github.com/google/glog).
247246

248-
To use glog*, complete the following steps:
247+
To use glog, complete the following steps:
249248

250-
1. Install glog* package of the latest version
249+
1. Install glog package of the latest version
251250

252251
```bash
253252
conda install glog
254253
```
255-
2. Build dpctl with the glog* support
254+
2. Build dpctl with the glog support
256255

257256
```bash
258257
python scripts/build_locally.py --oneapi --glog
259258
```
260259

261-
3. Use the `dpctl._diagnostics.syclinterface_diagnostics(verbosity="warning", log_dir=None)` context manager to switch library diagnostics on for a block of a Python* code.
260+
1. Use the `dpctl._diagnostics.syclinterface_diagnostics(verbosity="warning", log_dir=None)` context manager to switch library diagnostics on for a block of a Python code.
262261
Use `DPCTLService_InitLogger` and `DPCTLService_ShutdownLogger` library C functions during library development to initialize Google's logging library and de-initialize accordingly:
263262
264263
```python
@@ -278,4 +277,4 @@ Where:
278277
- `*log_dir` - a directory path for writing log files. Specifying `NULL` results in logging to ``std::cerr``.
279278
280279
> **_NOTE:_**
281-
> If `InitGoogleLogging` is not called before the first use of the glog*, the library self-initializes to the `logtostderr` mode, and log files are not generated.
280+
> If `InitGoogleLogging` is not called before the first use of the glog, the library self-initializes to the `logtostderr` mode, and log files are not generated.

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,44 @@
99

1010
# Data Parallel Control
1111

12-
Data Parallel Control or `dpctl` is a Python* library that allows users
12+
Data Parallel Control or `dpctl` is a Python library that allows users
1313
to *control* the execution placement of a [compute
1414
kernel](https://en.wikipedia.org/wiki/Compute_kernel) on an
15-
[XPU*](https://www.intel.com/content/www/us/en/newsroom/news/xpu-vision-oneapi-server-gpu.html).
15+
[XPU](https://www.intel.com/content/www/us/en/newsroom/news/xpu-vision-oneapi-server-gpu.html).
1616

1717
The compute kernel can be a code:
18-
* written by the user, e.g., using `numba-dppy`
18+
* written by the user, e.g., using [`numba-dpex`](https://github.com/IntelPython/numba-dpex)
1919
* that is part of a library, such as oneMKL
2020

21-
The `dpctl` library is built upon the [SYCL*
21+
The `dpctl` library is built upon the [SYCL
2222
standard](https://www.khronos.org/sycl/). It also 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
2626
* discover and represent devices and sub-devices
2727
* construct contexts and queues
2828

29-
`dpctl` features classes for [SYCL* Unified Shared Memory
29+
`dpctl` features classes for [SYCL Unified Shared Memory
3030
(USM)](https://link.springer.com/chapter/10.1007/978-1-4842-5574-2_6)
3131
management and implements a tensor [array
3232
API](https://data-apis.org/array-api/latest/).
3333

3434
The library helps authors of Python native extensions written
35-
in C, Cython*, or pybind11* to access `dpctl` objects representing SYCL*
35+
in C, Cython, or pybind11 to access `dpctl` objects representing SYCL
3636
devices, queues, memory, and tensors.
3737

38-
`Dpctl` is the core part of a larger family of [data-parallel Python*
38+
`Dpctl` is the core part of a larger family of [data-parallel Python
3939
libraries and tools](https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html)
4040
to program on XPUs.
4141

4242

4343

4444
# Installing
4545

46-
You can install the library with [conda*](https://anaconda.org/intel/dpctl) and
47-
[pip*](https://pypi.org/project/dpctl/). It is also available in the [Intel(R)
46+
You can install the library with [conda](https://anaconda.org/intel/dpctl) and
47+
[pip](https://pypi.org/project/dpctl/). It is also available in the [Intel(R)
4848
Distribution for
49-
Python*](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/distribution-for-python.html)
49+
Python](https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/distribution-for-python.html)
5050
(IDP).
5151

5252
## Inte(R) oneAPI
@@ -57,13 +57,13 @@ 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 Base Toolkit to get
60+
> **NOTE:** You need to install the Intel(R) oneAPI Basekit to get
6161
>IDP and `dpctl`.
6262
6363

6464
## Conda
6565

66-
To install `dpctl` from the Intel(R) channel on Annaconda*
66+
To install `dpctl` from the Intel(R) channel on Annaconda
6767
cloud, use the following command:
6868

6969
```bash
@@ -72,7 +72,7 @@ conda install dpctl -c intel
7272

7373
## PyPi
7474

75-
To install `dpctl` from PyPi*, run the following command:
75+
To install `dpctl` from PyPi, run the following command:
7676

7777
```bash
7878
pip3 install dpctl
@@ -82,7 +82,7 @@ Installing the bleeding edge
8282
------------------------
8383

8484
To try out the current master, install it from our
85-
development channel on Anaconda* cloud:
85+
development channel on Anaconda cloud:
8686

8787
```bash
8888
conda install dpctl -c dppy\label\dev
@@ -106,8 +106,8 @@ for script in `ls examples/python/`;
106106
done
107107
```
108108

109-
## Cython* extensions
110-
See examples of building Cython* extensions with DPC++ compiler that interoperates
109+
## Cython extensions
110+
See examples of building Cython extensions with DPC++ compiler that interoperates
111111
with `dpctl` in the [cython folder](examples\cython).
112112

113113
To build these examples, run:

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ consolidated documentation is generated using the provided build scripts.
1010
Prerequisite
1111
============
1212

13-
The following tools are needed in order to build the documentation for dpctl
13+
The following tools are needed in order to build the documentation for dpctl:
1414

1515
- `Sphinx`
1616
- `Doxygen`
@@ -22,18 +22,18 @@ output and add them to a consolidate `Sphinx` generated site. It is preferred
2222
that the latest `Doxyrest` binary is installed from
2323
https://github.com/vovkos/doxyrest/tags.
2424

25-
`Lua` is required if using `Doxyrest`. Please follow your OS specific
26-
instructions to install `liblua`. *E.g.*, on Ubuntu 20.04:
25+
`Lua` is required if using `Doxyrest`. Follow your OS specific
26+
instructions to install `liblua`. For example, on Ubuntu 20.04:
2727

2828
```
2929
sudo apt-get install liblua5.2-dev
3030
```
3131

32-
Generating the docs
33-
===================
32+
Generating The Documentation
33+
============================
3434

3535
The helper script ``scripts/gen_docs.py`` is the preferred way to generate the
36-
documentation. The generated documentation html pages will be installed to the
36+
documentation. The generated documentation HTML pages are installed to the
3737
``CMAKE_INSTALL_PREFIX/docs`` directory.
3838

3939
----------------------------

docs/docfiles/intro.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@ Welcome to the Data-parallel Control (dpctl) Documentation!
22
===========================================================
33

44
The data-parallel control (dpctl) library provides C and Python bindings for
5-
:sycl_spec_2020:`SYCL 2020 <>`. The SYCL* 2020 features supported by dpctl are
5+
:sycl_spec_2020:`SYCL 2020 <>`. The SYCL 2020 features supported by dpctl are
66
limited to those included by Intel(R) DPCPP compiler and specifically cover the
7-
SYCL* runtime classes described in :sycl_runtime_classes:`Section 4.6 <>`
8-
of the SYCL* 2020 specification.
7+
SYCL runtime classes described in :sycl_runtime_classes:`Section 4.6 <>`
8+
of the SYCL 2020 specification.
99

1010
Apart from the bindings for these runtime
11-
classes, dpctl includes bindings for SYCL* USM memory allocators and
12-
deallocators. Dpctl Python* API provides classes that implement
11+
classes, dpctl includes bindings for SYCL USM memory allocators and
12+
deallocators. Dpctl Python API provides classes that implement
1313
`Python buffer protocol <https://docs.python.org/3/c-api/buffer.html>`_
14-
using SYCL* USM memory. It makes it possible to create Python objects that are
14+
using SYCL USM memory. It makes it possible to create Python objects that are
1515
backed by SYCL USM memory.
1616

1717
Dpctl also supports the DPCPP :oneapi_filter_selection:`oneapi::filter_selector <>` extension and has

0 commit comments

Comments
 (0)