diff --git a/.wordlist.txt b/.wordlist.txt index e24ffb440..f26c0514f 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -332,6 +332,7 @@ ROCmSoftwarePlatform ROCmValidationSuite ROCprofiler ROCr +RPP RST RW Radeon @@ -572,6 +573,7 @@ hipBLASLt's hipblaslt hipCUB hipFFT +hipFORT hipLIB hipRAND hipSOLVER @@ -707,6 +709,7 @@ rocALUTION rocBLAS rocDecode rocFFT +rocHPCG rocJPEG rocLIB rocMLIR diff --git a/docs/index.md b/docs/index.md index da8cfba57..f3eee2a1f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -71,6 +71,7 @@ ROCm documentation is organized into the following categories: * [ROCm tools, compilers, and runtimes](./reference/rocm-tools.md) * [Accelerator and GPU hardware specifications](./reference/gpu-arch-specs.rst) * [Precision support](./reference/precision-support.rst) +* [Graph safe support](./reference/graph-safe-support.rst) ::: diff --git a/docs/reference/graph-safe-support.rst b/docs/reference/graph-safe-support.rst new file mode 100644 index 000000000..9382735ba --- /dev/null +++ b/docs/reference/graph-safe-support.rst @@ -0,0 +1,111 @@ +.. meta:: + :description: This page lists supported graph safe ROCm libraries. + :keywords: AMD, ROCm, HIP, hipGRAPH + +******************************************************************************** +Graph-safe support for ROCm libraries +******************************************************************************** + +HIP graph-safe libraries operate safely in HIP execution graphs. +:ref:`hip:how_to_HIP_graph` are an alternative way of executing tasks on a GPU +that can provide performance benefits over launching kernels using the standard +method via streams. + +Functions and routines from graph-safe libraries shouldn’t result in issues like +race conditions, deadlocks, or unintended dependencies. + +The following table shows whether a ROCm library is graph-safe. + +.. list-table:: + :header-rows: 1 + + * + - ROCm library + - Graph safe support + * + - `Composable Kernel `_ + - ❌ + * + - `hipBLAS `_ + - ✅ + * + - `hipBLASLt `_ + - ⚠️ + * + - `hipCUB `_ + - ✅ + * + - `hipFFT `_ + - ✅ (See :ref:`details `) + * + - `hipRAND `_ + - ✅ + * + - `hipSOLVER `_ + - ⚠️ (experimental) + * + - `hipSPARSE `_ + - ✅ + * + - `hipSPARSELt `_ + - ⚠️ (experimental) + * + - `hipTensor `_ + - ❌ + * + - `MIOpen `_ + - ❌ + * + - `RCCL `_ + - ✅ + * + - `rocAL `_ + - ❌ + * + - `rocALUTION `_ + - ❌ + * + - `rocBLAS `_ + - ✅ (See :doc:`details `) + * + - `rocDecode `_ + - ❌ + * + - `rocFFT `_ + - ✅ (See :ref:`details `) + * + - `rocHPCG `_ + - ❌ + * + - `rocJPEG `_ + - ❌ + * + - `rocPRIM `_ + - ✅ + * + - `rocRAND `_ + - ✅ + * + - `rocSOLVER `_ + - ⚠️ (experimental) + * + - `rocSPARSE `_ + - ⚠️ (experimental) + * + - `rocThrust `_ + - ❌ (See :doc:`details `) + * + - `rocWMMA `_ + - ❌ + * + - `RPP `_ + - ⚠️ + * + - `Tensile `_ + - ✅ + +✅: full support + +⚠️: partial support + +❌: not supported diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 297c908af..280600f5f 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -171,6 +171,8 @@ subtrees: title: Hardware specifications - file: reference/precision-support.rst title: Precision support + - file: reference/graph-safe-support.rst + title: Graph safe support - caption: Contribute entries: