Skip to content

Commit 7500f79

Browse files
author
github-actions[doc-deploy-bot]
committed
Latest docs.
1 parent 88b1b7f commit 7500f79

File tree

10 files changed

+44
-8
lines changed

10 files changed

+44
-8
lines changed

‎master/_sources/api_reference/libsyclinterface/generated/enum_DPCTLSyclBackendType.rst.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@ Redefinition of DPC++-specific Sycl backend types.
1818
:target:`DPCTL_OPENCL<doxid-d3/d94/dpctl__sycl__enum__types_8h_1aa217d239d7e3752c49bd9fd42c71c933afd3f682f4dee5939317fe0f55145dd66>` = 1<<18,
1919
:target:`DPCTL_UNKNOWN_BACKEND<doxid-d3/d94/dpctl__sycl__enum__types_8h_1aa217d239d7e3752c49bd9fd42c71c933a12a821ba9b114d4f5f808ada54e4a7af>` = 0,
2020
:target:`DPCTL_ALL_BACKENDS<doxid-d3/d94/dpctl__sycl__enum__types_8h_1aa217d239d7e3752c49bd9fd42c71c933a91fcd924cbde7c895056a69a8a5b3e22>` =((1<<5)-1)<<16,
21+
:target:`DPCTL_HIP<doxid-d3/d94/dpctl__sycl__enum__types_8h_1aa217d239d7e3752c49bd9fd42c71c933ae4a6db2d4436c1dfcfd5a43d9de473d1>` = 1<<19,
2122
};
2223

‎master/_sources/beginners_guides/installation.rst.txt‎

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
==========================

‎master/_sources/beginners_guides/managing_devices.rst.txt‎

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

‎master/api_reference/dpctl/generated/dpctl.get_devices.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ <h1>dpctl.get_devices<a class="headerlink" href="#dpctl-get-devices" title="Perm
831831
<dd class="field-odd"><ul class="simple">
832832
<li><p><strong>backend</strong> (<em>optional</em>) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code> enum value or a string that
833833
specifies a SYCL backend. Currently, accepted values are: “cuda”,
834-
“opencl”, “level_zero”, or “all”.
834+
“hip”, “opencl”, “level_zero”, or “all”.
835835
Default: <code class="docutils literal notranslate"><span class="pre">dpctl.backend_type.all</span></code>.</p></li>
836836
<li><p><strong>device_type</strong> (<em>optional</em>) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> enum value or a string that
837837
specifies a SYCL device type. Currently, accepted values are:

‎master/api_reference/dpctl/generated/dpctl.get_num_devices.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -828,7 +828,7 @@ <h1>dpctl.get_num_devices<a class="headerlink" href="#dpctl-get-num-devices" tit
828828
<dd class="field-odd"><ul class="simple">
829829
<li><p><strong>backend</strong> (<em>optional</em>) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.backend_type</span></code> enum value or a string that
830830
specifies a SYCL backend. Currently, accepted values are: “cuda”,
831-
“opencl”, “level_zero”, or “all”.
831+
“hip”, “opencl”, “level_zero”, or “all”.
832832
Default: <code class="docutils literal notranslate"><span class="pre">dpctl.backend_type.all</span></code>.</p></li>
833833
<li><p><strong>device_type</strong> (<em>optional</em>) – A <code class="xref py py-class docutils literal notranslate"><span class="pre">dpctl.device_type</span></code> enum value or a string that
834834
specifies a SYCL device type. Currently, accepted values are:

‎master/api_reference/libsyclinterface/generated/enum_DPCTLSyclBackendType.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -828,6 +828,7 @@
828828
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1aa217d239d7e3752c49bd9fd42c71c933afd3f682f4dee5939317fe0f55145dd66"><span></span><span class="n">DPCTL_OPENCL</span></span><span></span> <span class="o">=</span> <span class="mi">1</span><span class="o">&lt;&lt;</span><span class="mi">18</span><span class="p">,</span>
829829
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1aa217d239d7e3752c49bd9fd42c71c933a12a821ba9b114d4f5f808ada54e4a7af"><span></span><span class="n">DPCTL_UNKNOWN_BACKEND</span></span><span></span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
830830
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1aa217d239d7e3752c49bd9fd42c71c933a91fcd924cbde7c895056a69a8a5b3e22"><span></span><span class="n">DPCTL_ALL_BACKENDS</span></span><span></span> <span class="o">=</span><span class="p">((</span><span class="mi">1</span><span class="o">&lt;&lt;</span><span class="mi">5</span><span class="p">)</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span><span class="o">&lt;&lt;</span><span class="mi">16</span><span class="p">,</span>
831+
<span class="doxyrest-code-target target" id="doxid-d3-d94-dpctl-sycl-enum-types-8h-1aa217d239d7e3752c49bd9fd42c71c933ae4a6db2d4436c1dfcfd5a43d9de473d1"><span></span><span class="n">DPCTL_HIP</span></span><span></span> <span class="o">=</span> <span class="mi">1</span><span class="o">&lt;&lt;</span><span class="mi">19</span><span class="p">,</span>
831832
<span class="p">};</span></pre>
832833
</section>
833834

‎master/beginners_guides/installation.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -881,7 +881,7 @@ <h2>Installation using pip<a class="headerlink" href="#installation-using-pip" t
881881
<section id="installation-via-intel-r-distribution-for-python">
882882
<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>
883883
<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
884-
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.17.0dev2+16.g475c5313d62)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpnp</span></code></a>
884+
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.17.0dev2+17.gcd233611559)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dpnp</span></code></a>
885885
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>
886886
<p>Once the installed environment is activated, <code class="docutils literal notranslate"><span class="pre">dpctl</span></code> should be ready to use.</p>
887887
</section>
@@ -946,10 +946,22 @@ <h3>Building for custom SYCL targets<a class="headerlink" href="#building-for-cu
946946
<li><p><a class="reference external" href="https://developer.codeplay.com/products/oneapi/amd/">oneAPI for AMD GPUs</a></p></li>
947947
</ul>
948948
</div></blockquote>
949-
<p>Build <code class="docutils literal notranslate"><span class="pre">dpctl</span></code> as follows:</p>
949+
<p><code class="docutils literal notranslate"><span class="pre">dpctl</span></code> can be built for CUDA devices as follows:</p>
950950
<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_CUDA=ON&quot;</span>
951951
</pre></div>
952952
</div>
953+
<p>And for AMD devices</p>
954+
<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>
955+
</pre></div>
956+
</div>
957+
<p>Note that the <cite>oneAPI for AMD GPUs</cite> plugin requires the architecture be specified and only
958+
one architecture can be specified at a time.</p>
959+
<p>It is, however, possible to build for Intel devices, CUDA devices, and an AMD device
960+
architecture all at once:</p>
961+
<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_CUDA=ON \</span>
962+
<span class="s2">-DDPCTL_TARGET_HIP=gfx1030&quot;</span>
963+
</pre></div>
964+
</div>
953965
</section>
954966
</section>
955967
<section id="running-examples-and-tests">

‎master/beginners_guides/managing_devices.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -928,10 +928,13 @@ <h3>Listing devices programmatically<a class="headerlink" href="#listing-devices
928928
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">cuda:*</span></code></p></td>
929929
<td><p>All devices only from CUDA backend are available</p></td>
930930
</tr>
931-
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">level_zero:0,1</span></code></p></td>
931+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">hip:*</span></code></p></td>
932+
<td><p>All devices only from HIP backend are available</p></td>
933+
</tr>
934+
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">level_zero:0,1</span></code></p></td>
932935
<td><p>Two specific devices from Level-Zero backend are available</p></td>
933936
</tr>
934-
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">level_zero:gpu;cuda:gpu;opencl:cpu</span></code></p></td>
937+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">level_zero:gpu;cuda:gpu;opencl:cpu</span></code></p></td>
935938
<td><p>Level-Zero GPU devices, CUDA GPU devices, and OpenCL CPU devices are available</p></td>
936939
</tr>
937940
</tbody>

‎master/objects.inv‎

27 Bytes
Binary file not shown.

‎master/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)