Skip to content

Commit daeb5cc

Browse files
author
github-actions[doc-deploy-bot]
committed
Docs for pull request 2098
1 parent 3804337 commit daeb5cc

File tree

4 files changed

+23
-6
lines changed

4 files changed

+23
-6
lines changed

pulls/2098/_sources/beginners_guides/installation.rst.txt

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,11 +197,24 @@ which requires specifying a compute architecture string:
197197

198198
.. code-block:: bash
199199
200-
python scripts/build_locally.py --verbose --cmake-opts="-DDPCTL_TARGET_HIP=gfx1030"
200+
python scripts/build_locally.py --verbose --cmake-opts="-DDPCTL_TARGET_HIP=<arch>"
201201
202-
Note that the `oneAPI for AMD GPUs` plugin requires the architecture be specified and only
202+
Note that the `oneAPI for AMD GPUs` plugin requires the architecture be specified and only
203203
one architecture can be specified at a time.
204204

205+
To determine the architecture code (``<arch>``) for your AMD GPU, run:
206+
207+
.. code-block:: bash
208+
rocminfo | grep 'Name: *gfx.*'
209+
210+
This will print names like ``gfx90a``, ``gfx1030``, etc.
211+
You can then use one of them as the argument to ``-DDPCTL_TARGET_HIP``.
212+
213+
For example:
214+
215+
.. code-block:: bash
216+
python scripts/build_locally.py --verbose --cmake-opts="-DDPCTL_TARGET_HIP=gfx1030"
217+
205218
Multi-target build
206219
~~~~~~~~~~~~~~~~~~
207220

pulls/2098/beginners_guides/installation.html

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -868,7 +868,7 @@ <h2>Installation using pip<a class="headerlink" href="#installation-using-pip" t
868868
<section id="installation-via-intel-r-distribution-for-python">
869869
<h2>Installation via Intel(R) Distribution for Python<a class="headerlink" href="#installation-via-intel-r-distribution-for-python" title="Permalink to this heading"></a></h2>
870870
<p><a class="reference external" href="https://www.intel.com/content/www/us/en/developer/tools/oneapi/distribution-for-python.html">Intel(R) Distribution for Python*</a> is distributed as a conda-based installer
871-
and includes <a class="reference internal" href="../api_reference/dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a> along with its dependencies and sister projects <a class="reference external" href="https://intelpython.github.io/dpnp/overview.html#module-dpnp" title="(in Data Parallel Extension for NumPy v0.19.0dev0+19.g278cf429f61)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpnp</span></code></a>
871+
and includes <a class="reference internal" href="../api_reference/dpctl/index.html#module-dpctl" title="dpctl"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpctl</span></code></a> along with its dependencies and sister projects <a class="reference external" href="https://intelpython.github.io/dpnp/overview.html#module-dpnp" title="(in Data Parallel Extension for NumPy v0.19.0dev0+25.g78597f92423)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpnp</span></code></a>
872872
and <a class="reference external" href="https://intelpython.github.io/numba-dpex/latest/index.html#module-numba_dpex" title="(in numba-dpex)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">numba_dpex</span></code></a>.</p>
873873
<p>Once the installed environment is activated, <code class="docutils literal notranslate"><span class="pre">dpctl</span></code> should be ready to use.</p>
874874
</section>
@@ -960,11 +960,15 @@ <h4>CUDA build<a class="headerlink" href="#cuda-build" title="Permalink to this
960960
<h4>AMD build<a class="headerlink" href="#amd-build" title="Permalink to this heading"></a></h4>
961961
<p><code class="docutils literal notranslate"><span class="pre">dpctl</span></code> can be built for AMD devices using the <code class="docutils literal notranslate"><span class="pre">DPCTL_TARGET_HIP</span></code> CMake option,
962962
which requires specifying a compute architecture string:</p>
963-
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>scripts/build_locally.py<span class="w"> </span>--verbose<span class="w"> </span>--cmake-opts<span class="o">=</span><span class="s2">&quot;-DDPCTL_TARGET_HIP=gfx1030&quot;</span>
963+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>scripts/build_locally.py<span class="w"> </span>--verbose<span class="w"> </span>--cmake-opts<span class="o">=</span><span class="s2">&quot;-DDPCTL_TARGET_HIP=&lt;arch&gt;&quot;</span>
964964
</pre></div>
965965
</div>
966-
<p>Note that the <cite>oneAPI for AMD GPUs</cite> plugin requires the architecture be specified and only
966+
<p>Note that the <cite>oneAPI for AMD GPUs</cite> plugin requires the architecture be specified and only
967967
one architecture can be specified at a time.</p>
968+
<p>To determine the architecture code (<code class="docutils literal notranslate"><span class="pre">&lt;arch&gt;</span></code>) for your AMD GPU, run:</p>
969+
<p>This will print names like <code class="docutils literal notranslate"><span class="pre">gfx90a</span></code>, <code class="docutils literal notranslate"><span class="pre">gfx1030</span></code>, etc.
970+
You can then use one of them as the argument to <code class="docutils literal notranslate"><span class="pre">-DDPCTL_TARGET_HIP</span></code>.</p>
971+
<p>For example:</p>
968972
</section>
969973
<section id="multi-target-build">
970974
<h4>Multi-target build<a class="headerlink" href="#multi-target-build" title="Permalink to this heading"></a></h4>

pulls/2098/objects.inv

0 Bytes
Binary file not shown.

pulls/2098/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)