Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention oneDPL TPL #496

Merged
merged 3 commits into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/source/API/core/Macros.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@ These defines give information about what third-party libaries Kokkos was compil
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| ``KOKKOS_ENABLE_LIBQUADMATH`` | Defined if Kokkos links to the `GCC Quad-Precision Math Library API <https://gcc.gnu.org/onlinedocs/libquadmath/>`_. |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| ``KOKKOS_ENABLE_ONEDPL`` | Defined if Kokkos links to the `oneDPL library <https://github.com/oneapi-src/oneDPL>`_ when using the SYCL backend. |
| | Enabling this TPL might affect performance for Kokkos algorithms that use it, e.g., `sort`. |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we expand to say what it is used for and that things like Kokkos::sort might be less performant if not found?

It is fine if you want to do as a follow up.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Architectures
-------------
Expand Down
3 changes: 3 additions & 0 deletions docs/source/keywords.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,9 @@ The following options control enabling TPLs:
* * ``Kokkos_ENABLE_LIBDL``
* Whether to enable the LIBDL library
* ``ON``
* * ``Kokkos_ENABLE_ONEDPL``
* Whether to enable the oneDPL library
* ``ON``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No language about it being a SYCL-specific TPL?


The following options control finding and configuring non-CMake TPLs:

Expand Down
Loading