Skip to content

Commit 4cd067d

Browse files
Merge pull request #1662 from bdmoore1/bdmoore1-contributor-guides-review
Review of contributor guides
2 parents be47bef + ffd9008 commit 4cd067d

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

docs/doc_sources/contributor_guides/building.rst

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,34 @@ CUDA support or try latest features.
1313
Building using oneAPI DPC++
1414
---------------------------
1515

16-
Install oneAPI and graphics drivers to the system prior
17-
to proceeding further.
16+
17+
Prerequisites
18+
~~~~~~~~~~~~~
19+
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:: powershell
37+
38+
&$Env:CONDA_PREFIX\Scripts\script_name.ps1
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+
1844

1945
Activate oneAPI
2046
~~~~~~~~~~~~~~~

docs/doc_sources/contributor_guides/memory_ownership_sycl_interface.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Working with DPCTLSyclInterface library
44
=======================================
55

6-
The DPCLSyclInterface library is a C-API library which does provide select C++ functions
6+
The DPCLSyclInterface library is a C-API library which provides select C++ functions
77
for casting from C opaque pointers to pointers to corresponding C++ classes.
88

99
This document explains the memory ownership model adopted by DPCTLSyclInterface.

0 commit comments

Comments
 (0)