|
3 | 3 | Building from the Source
|
4 | 4 | ========================
|
5 | 5 |
|
6 |
| -To build :py:mod:`dpctl` from the source, you need the Intel(R) oneAPI DPC++ compiler. |
| 6 | +To build :py:mod:`dpctl` from the source, you need DPC++ compiler. |
7 | 7 | To run examples and test suite you would need GPU drivers and/or CPU
|
8 | 8 | OpenCL drivers. It is preferable to use the Intel(R) oneAPI DPC++ compiler
|
9 |
| -available as part of the oneAPI Base Kit. However, it is possible to use a custom |
| 9 | +available as part of oneAPI Base-Kit. However, it is possible to use a custom |
10 | 10 | build of DPC++ to build :py:mod:`dpctl`, especially if you want to enable
|
11 |
| -CUDA* support or try the latest features. |
| 11 | +CUDA support or try latest features. |
12 | 12 |
|
13 | 13 | Building using oneAPI DPC++
|
14 | 14 | ---------------------------
|
15 | 15 |
|
| 16 | + |
16 | 17 | Prerequisites
|
17 | 18 | ~~~~~~~~~~~~~
|
18 | 19 |
|
19 |
| -Install oneAPI and graphics drivers to the system. |
| 20 | +Install oneAPI and graphics drivers according to your targeted hardware: |
| 21 | + |
| 22 | + |
| 23 | +- To target Intel GPUs, see the `Installation Page <https://dgpu-docs.intel.com/driver/installation.html>`_ |
| 24 | + of the Intel(R) software for general purpose GPU capabilities document for |
| 25 | + driver information. |
| 26 | +- To target NVIDIA* or AMD* GPUs, see the vendor website for drivers, as well |
| 27 | + as `CodePlay plugins <https://codeplay.com/solutions/oneapi/plugins/>`_ to |
| 28 | + enable hardware targeting. |
| 29 | +- To target a CPU, the OpenCL* CPU driver is included as a part of the |
| 30 | + oneAPI DPC++ Compiler installation. The CPU |
| 31 | + driver is also packaged in conda, and is automatically made available using |
| 32 | + conda activation scripts on Linux*, and on Windows* (in user-mode). |
| 33 | + If conda is used with elevated privileges in Windows (similar to |
| 34 | + GitHub Actions CI), a PowerShell script must be run: |
| 35 | + |
| 36 | + .. code-block:: bash |
| 37 | +
|
| 38 | + ${CONDA_PREFIX}\\Scripts. |
| 39 | +
|
| 40 | +Use the script ``set-intel-ocl-icd-registry.ps1`` to set |
| 41 | +appropriate registry key, and ``unset-intel-ocl-icd-registry.ps1`` |
| 42 | +to remove it. |
| 43 | + |
20 | 44 |
|
21 | 45 | Activate oneAPI
|
22 | 46 | ~~~~~~~~~~~~~~~
|
@@ -140,7 +164,7 @@ You can build dpctl from the source using the `DPC++ toolchain <https://github.c
|
140 | 164 | instead of the DPC++ compiler that comes with oneAPI.
|
141 | 165 |
|
142 | 166 | Following steps in the `Build and install with scikit-build`_ use a command-line option to set
|
143 |
| -the relevant CMake variables. For example: |
| 167 | +the relevant CMake variables, for example: |
144 | 168 |
|
145 | 169 | .. code-block:: bash
|
146 | 170 |
|
@@ -169,7 +193,7 @@ To build the library, you need:
|
169 | 193 | * ``ninja`` or ``make``
|
170 | 194 | * Optionally ``gtest 1.10`` if you want to build and run the test suite
|
171 | 195 |
|
172 |
| -For example, on Linux* OS the following script can be used to build the C oneAPI |
| 196 | +For example, on Linux OS the following script can be used to build the C oneAPI |
173 | 197 | library.
|
174 | 198 |
|
175 | 199 | .. code-block:: bash
|
|
0 commit comments