Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed May 27, 2024
1 parent 77e833f commit 6fb0572
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 24 deletions.
25 changes: 13 additions & 12 deletions _sources/domains/sparse_linear_algebra.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ OneMKL Intel CPU and GPU backends

Known limitations as of Intel oneMKL product release 2024.1:

- All operations' algorithms except `no_optimize_alg` map to the default
- All operations' algorithms except ``no_optimize_alg`` map to the default
algorithm.
- `oneapi::mkl::sparse::set_csr_data` and `oneapi::mkl::sparse::set_coo_data`
functions cannot be used on a handle that has already been used for an operation
or its optimize function. Doing so will throw an `oneapi::mkl::unimplemented`
exception.
- Using `spmm` with a sparse matrix that is `oneapi::mkl::transpose::conjtrans`
and has the `oneapi::mkl::sparse::matrix_property::symmetric` property will
throw an `oneapi::mkl::unimplemented` exception.
- Using `spsv` with the `oneapi::mkl::sparse::spsv_alg::no_optimize_alg` and a
sparse matrix that does not have the
`oneapi::mkl::sparse::matrix_property::sorted` property will throw an
`oneapi::mkl::unimplemented` exception.
- ``oneapi::mkl::sparse::set_csr_data`` and
``oneapi::mkl::sparse::set_coo_data`` functions cannot be used on a handle
that has already been used for an operation or its optimize function. Doing so
will throw an ``oneapi::mkl::unimplemented`` exception.
- Using ``spmm`` with a sparse matrix that is
``oneapi::mkl::transpose::conjtrans`` and has the
``oneapi::mkl::sparse::matrix_property::symmetric`` property will throw an
``oneapi::mkl::unimplemented`` exception.
- Using ``spsv`` with the ``oneapi::mkl::sparse::spsv_alg::no_optimize_alg`` and
a sparse matrix that does not have the
``oneapi::mkl::sparse::matrix_property::sorted`` property will throw an
``oneapi::mkl::unimplemented`` exception.
25 changes: 13 additions & 12 deletions domains/sparse_linear_algebra.html
Original file line number Diff line number Diff line change
Expand Up @@ -541,19 +541,20 @@ <h2> Contents </h2>
<h2>OneMKL Intel CPU and GPU backends<a class="headerlink" href="#onemkl-intel-cpu-and-gpu-backends" title="Link to this heading">#</a></h2>
<p>Known limitations as of Intel oneMKL product release 2024.1:</p>
<ul class="simple">
<li><p>All operations’ algorithms except <cite>no_optimize_alg</cite> map to the default
<li><p>All operations’ algorithms except <code class="docutils literal notranslate"><span class="pre">no_optimize_alg</span></code> map to the default
algorithm.</p></li>
<li><p><cite>oneapi::mkl::sparse::set_csr_data</cite> and <cite>oneapi::mkl::sparse::set_coo_data</cite>
functions cannot be used on a handle that has already been used for an operation
or its optimize function. Doing so will throw an <cite>oneapi::mkl::unimplemented</cite>
exception.</p></li>
<li><p>Using <cite>spmm</cite> with a sparse matrix that is <cite>oneapi::mkl::transpose::conjtrans</cite>
and has the <cite>oneapi::mkl::sparse::matrix_property::symmetric</cite> property will
throw an <cite>oneapi::mkl::unimplemented</cite> exception.</p></li>
<li><p>Using <cite>spsv</cite> with the <cite>oneapi::mkl::sparse::spsv_alg::no_optimize_alg</cite> and a
sparse matrix that does not have the
<cite>oneapi::mkl::sparse::matrix_property::sorted</cite> property will throw an
<cite>oneapi::mkl::unimplemented</cite> exception.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">oneapi::mkl::sparse::set_csr_data</span></code> and
<code class="docutils literal notranslate"><span class="pre">oneapi::mkl::sparse::set_coo_data</span></code> functions cannot be used on a handle
that has already been used for an operation or its optimize function. Doing so
will throw an <code class="docutils literal notranslate"><span class="pre">oneapi::mkl::unimplemented</span></code> exception.</p></li>
<li><p>Using <code class="docutils literal notranslate"><span class="pre">spmm</span></code> with a sparse matrix that is
<code class="docutils literal notranslate"><span class="pre">oneapi::mkl::transpose::conjtrans</span></code> and has the
<code class="docutils literal notranslate"><span class="pre">oneapi::mkl::sparse::matrix_property::symmetric</span></code> property will throw an
<code class="docutils literal notranslate"><span class="pre">oneapi::mkl::unimplemented</span></code> exception.</p></li>
<li><p>Using <code class="docutils literal notranslate"><span class="pre">spsv</span></code> with the <code class="docutils literal notranslate"><span class="pre">oneapi::mkl::sparse::spsv_alg::no_optimize_alg</span></code> and
a sparse matrix that does not have the
<code class="docutils literal notranslate"><span class="pre">oneapi::mkl::sparse::matrix_property::sorted</span></code> property will throw an
<code class="docutils literal notranslate"><span class="pre">oneapi::mkl::unimplemented</span></code> exception.</p></li>
</ul>
</section>
</section>
Expand Down

0 comments on commit 6fb0572

Please sign in to comment.