@@ -7,14 +7,14 @@ Installing ``dpctl``
7
7
License
8
8
=======
9
9
10
- :py:mod: `dpctl ` is licensed under Apache License 2.0 that can be found in
10
+ :py:mod: `dpctl ` is licensed under Apache* License 2.0 that can be found in the
11
11
`LICENSE <dpctl_license _>`_ file.
12
12
All usage and contributions to the project are subject to the terms and
13
13
conditions of this license.
14
14
15
15
.. _dpctl_license : https://github.com/IntelPython/dpctl/blob/master/LICENSE
16
16
17
- See user guide :ref: `document <user_guide_dpctl_license >` for additional information.
17
+ See the user guide :ref: `document <user_guide_dpctl_license >` for additional information.
18
18
19
19
Installation using conda
20
20
========================
@@ -24,24 +24,24 @@ ecosystem.
24
24
25
25
.. _conda_docs : https://docs.conda.io/projects/conda/en/stable/
26
26
27
- Released versions of the package can be installed from Intel channel, as
27
+ Released versions of the package can be installed from the Intel channel, as
28
28
indicated by ``--channel intel `` option:
29
29
30
30
.. code-block :: bash
31
31
:caption: Getting latest released version of ` ` dpctl` ` using conda
32
32
33
33
conda create --name dpctl_env --channel intel dpctl
34
34
35
- Development builds of ``dpctl `` can be accessed from ``dppy/label/dev `` channel:
35
+ Development builds of ``dpctl `` can be accessed from the ``dppy/label/dev `` channel:
36
36
37
37
.. code-block :: bash
38
38
:caption: Getting latest development version
39
39
40
40
conda create -n dpctl_nightly -c dppy/label/dev -c intel dpctl
41
41
42
42
.. note ::
43
- In case :py:mod: `dpctl ` is not available for the Python version of interest,
44
- please check `Building from source `_ section .
43
+ If :py:mod: `dpctl ` is not available for the Python version of interest,
44
+ see `Building from source `_.
45
45
46
46
47
47
Installation using pip
63
63
python -m pip install --index-url https://pypi.anaconda.org/intel/simple dpctl
64
64
65
65
.. note ::
66
- Installation using ``pip `` on Linux currently (as of April 2024) requires
66
+ As of April 2024, installation using ``pip `` on Linux* requires
67
67
that host operating system had ``libstdc++.so `` library version 6.0.29
68
68
or later. Check the version you have by executing
69
69
``find /lib/x86_64-linux-gnu/ -name "libstdc++*" ``
70
70
71
71
.. note ::
72
- In case :py:mod: `dpctl ` is not available for the Python version of interest,
73
- please check `Building from source `_ section .
72
+ If :py:mod: `dpctl ` is not available for the Python version of interest,
73
+ see `Building from source `_.
74
74
75
75
76
76
Installation via Intel(R) Distribution for Python
@@ -87,7 +87,7 @@ Once the installed environment is activated, ``dpctl`` should be ready to use.
87
87
System requirements
88
88
===================
89
89
90
- Since :py:mod: `dpctl ` is compiled using Intel(R) oneAPI DPC++ compiler,
90
+ Since :py:mod: `dpctl ` is compiled using the Intel(R) oneAPI DPC++ compiler,
91
91
the `compiler's system requirements for runtime <dpcpp_system_reqs _>`_ must be met.
92
92
93
93
In order for DPC++ runtime to recognize supported hardware appropriate drivers must be installed.
@@ -97,14 +97,15 @@ Directions to install drivers for Intel GPU devices are available at https://dgp
97
97
98
98
Once ``dpctl `` is installed, use ``python -m dpctl --full-list `` to list recognized devices.
99
99
100
- For ``dpctl `` to target Intel GPU devices, appropriate drivers should be installed systemwide .
100
+ For ``dpctl `` to target Intel GPU devices, appropriate drivers should be installed system wide .
101
101
Please refer to `GPU installation guide <gpu_stack_installation_guide _>`_ for detailed
102
102
instructions on how to install required drivers on Linux.
103
103
104
104
.. _gpu_stack_installation_guide : https://dgpu-docs.intel.com/
105
105
106
106
.. note ::
107
- Instructions for setting up GPU drivers in Windows Subsystem for Linux (WSL) is forthcoming.
107
+ Instructions for setting up GPU drivers in Windows Subsystem for Linux (WSL)
108
+ will be added in a future release of this document.
108
109
109
110
Building from source
110
111
====================
@@ -192,7 +193,7 @@ each example Python project and how to execute its test suite.
192
193
Running the Python Tests
193
194
------------------------
194
195
195
- You can execute Python test suite of :py:mod: `dpctl ` as follow :
196
+ You can execute Python test suite of :py:mod: `dpctl ` with :
196
197
197
198
.. code-block :: bash
198
199
0 commit comments