Skip to content

Commit c316380

Browse files
committed
Add documentation on building for AMD devices to dpctl installation guide
1 parent ac6cc7b commit c316380

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

docs/doc_sources/beginners_guides/installation.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,12 +158,28 @@ The following plugins from CodePlay are supported:
158158
.. _codeplay_nv_plugin: https://developer.codeplay.com/products/oneapi/nvidia/
159159
.. _codeplay_amd_plugin: https://developer.codeplay.com/products/oneapi/amd/
160160

161-
Build ``dpctl`` as follows:
161+
``dpctl`` can be built for CUDA devices as follows:
162162

163163
.. code-block:: bash
164164
165165
python scripts/build_locally.py --verbose --cmake-opts="-DDPCTL_TARGET_CUDA=ON"
166166
167+
And for AMD devices
168+
169+
.. code-block:: bash
170+
171+
python scripts/build_locally.py --verbose --cmake-opts="-DDPCTL_TARGET_HIP=gfx1030"
172+
173+
Note that the `oneAPI for AMD GPUs` plugin requires the architecture be specified and only
174+
one architecture can be specified at a time.
175+
176+
It is, however, possible to build for Intel devices, CUDA devices, and an AMD device
177+
architecture all at once:
178+
179+
.. code-block:: bash
180+
181+
python scripts/build_locally.py --verbose --cmake-opts="-DDPCTL_TARGET_CUDA=ON \
182+
-DDPCTL_TARGET_HIP=gfx1030"
167183
168184
Running Examples and Tests
169185
==========================

docs/doc_sources/beginners_guides/managing_devices.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,9 @@ of valid settings are:
123123
* - ``cuda:*``
124124
- All devices only from CUDA backend are available
125125
126+
* - ``hip:*``
127+
- All devices only from HIP backend are available
128+
126129
* - ``level_zero:0,1``
127130
- Two specific devices from Level-Zero backend are available
128131

0 commit comments

Comments
 (0)