Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed Oct 9, 2024
1 parent 11bbc4d commit 816d404
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 9 deletions.
23 changes: 19 additions & 4 deletions _sources/building_the_project_with_dpcpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,10 @@ SYCL enables portable heterogeneous computing on a wide range of accelerators.
Consequently, it is possible to use oneMKL Interfaces with accelerators not
anticipated by the oneMKL Interfaces team.

For generic SYCL devices, only the portBLAS backend is enabled. The user must
set the appropriate ``-fsycl-targets`` for their device, and also any
``PORTBLAS_TUNING_TARGET`` required for performance. See
`Building for portBLAS`_. Extensive testing is strongly advised for these
For generic SYCL devices, only portBLAS and portFFT backend are enabled.
The user must set the appropriate ``-fsycl-targets`` for their device, and also
any other option required for performance. See `Building for portBLAS`_ and
`Building for portFFT`_. Extensive testing is strongly advised for these
unsupported configurations.

.. _build_for_portlibs_dpcpp:
Expand Down Expand Up @@ -438,6 +438,21 @@ Note that this is not a tested configuration. This builds oneMKL Interfaces
with the portBLAS backend only, for a generic SYCL device supported by the
Open DPC++ project.

Build oneMKL for the DFT domain on a generic SYCL device:

.. code-block:: bash
cmake $ONEMKL_DIR \
-DCMAKE_CXX_COMPILER=clang++ \
-DCMAKE_C_COMPILER=clang \
-DENABLE_MKLCPU_BACKEND=False \
-DENABLE_MKLGPU_BACKEND=False \
-DENABLE_PORTFFT_BACKEND=True
Note that this is not a tested configuration. This builds oneMKL Interfaces
with the portFFT backend only, for a generic SYCL device supported by the
Open DPC++ project.

.. _project_cleanup:

Project Cleanup
Expand Down
20 changes: 16 additions & 4 deletions building_the_project_with_dpcpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -779,10 +779,10 @@ <h2>Backends<a class="headerlink" href="#backends" title="Link to this heading">
<p>SYCL enables portable heterogeneous computing on a wide range of accelerators.
Consequently, it is possible to use oneMKL Interfaces with accelerators not
anticipated by the oneMKL Interfaces team.</p>
<p>For generic SYCL devices, only the portBLAS backend is enabled. The user must
set the appropriate <code class="docutils literal notranslate"><span class="pre">-fsycl-targets</span></code> for their device, and also any
<code class="docutils literal notranslate"><span class="pre">PORTBLAS_TUNING_TARGET</span></code> required for performance. See
<a class="reference internal" href="#building-for-portblas">Building for portBLAS</a>. Extensive testing is strongly advised for these
<p>For generic SYCL devices, only portBLAS and portFFT backend are enabled.
The user must set the appropriate <code class="docutils literal notranslate"><span class="pre">-fsycl-targets</span></code> for their device, and also
any other option required for performance. See <a class="reference internal" href="#building-for-portblas">Building for portBLAS</a> and
<a class="reference internal" href="#building-for-portfft">Building for portFFT</a>. Extensive testing is strongly advised for these
unsupported configurations.</p>
</section>
<section id="pure-sycl-backends-portblas-and-portfft">
Expand Down Expand Up @@ -950,6 +950,18 @@ <h2>Backends<a class="headerlink" href="#backends" title="Link to this heading">
<p>Note that this is not a tested configuration. This builds oneMKL Interfaces
with the portBLAS backend only, for a generic SYCL device supported by the
Open DPC++ project.</p>
<p>Build oneMKL for the DFT domain on a generic SYCL device:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cmake<span class="w"> </span><span class="nv">$ONEMKL_DIR</span><span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-DCMAKE_CXX_COMPILER<span class="o">=</span>clang++<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-DCMAKE_C_COMPILER<span class="o">=</span>clang<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-DENABLE_MKLCPU_BACKEND<span class="o">=</span>False<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-DENABLE_MKLGPU_BACKEND<span class="o">=</span>False<span class="w"> </span><span class="se">\</span>
<span class="w"> </span>-DENABLE_PORTFFT_BACKEND<span class="o">=</span>True
</pre></div>
</div>
<p>Note that this is not a tested configuration. This builds oneMKL Interfaces
with the portFFT backend only, for a generic SYCL device supported by the
Open DPC++ project.</p>
</section>
<section id="project-cleanup">
<span id="id6"></span><h2>Project Cleanup<a class="headerlink" href="#project-cleanup" title="Link to this heading">#</a></h2>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 816d404

Please sign in to comment.