diff --git a/docs/.sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in index a62de6402..4b212b18e 100644 --- a/docs/.sphinx/_toc.yml.in +++ b/docs/.sphinx/_toc.yml.in @@ -42,7 +42,7 @@ subtrees: title: Math Libraries subtrees: - entries: - - file: reference/gpu_libraries/blas + - file: reference/gpu_libraries/linear_algebra subtrees: - entries: - title: rocBLAS @@ -51,6 +51,16 @@ subtrees: url: https://rocmdocs.amd.com/projects/hipBLAS/en/{branch}/ - title: rocWMMA url: https://rocmdocs.amd.com/projects/rocWMMA/en/{branch}/ + - title: rocSPARSE + url: https://rocmdocs.amd.com/projects/rocSPARSE/en/{branch}/ + - title: hipSPARSE + url: https://rocmdocs.amd.com/projects/hipSPARSE/en/{branch}/ + - title: rocALUTION + url: https://rocmdocs.amd.com/projects/rocALUTION/en/{branch}/ + - title: rocSOLVER + url: https://rocmdocs.amd.com/projects/rocSOLVER/en/{branch}/ + - title: hipSOLVER + url: https://rocmdocs.amd.com/projects/hipSOLVER/en/{branch}/ - file: reference/gpu_libraries/fft subtrees: - entries: @@ -65,20 +75,6 @@ subtrees: url: https://rocmdocs.amd.com/projects/rocRAND/en/{branch}/ - title: hipRAND url: https://rocmdocs.amd.com/projects/hipRAND/en/{branch}/ - - file: reference/gpu_libraries/solver - subtrees: - - entries: - - title: rocSOLVER - url: https://rocmdocs.amd.com/projects/rocSOLVER/en/{branch}/ - - title: hipSOLVER - url: https://rocmdocs.amd.com/projects/hipSOLVER/en/{branch}/ - - file: reference/gpu_libraries/sparse - subtrees: - - entries: - - title: rocSPARSE - url: https://rocmdocs.amd.com/projects/rocSPARSE/en/{branch}/ - - title: hipSPARSE - url: https://rocmdocs.amd.com/projects/hipSPARSE/en/{branch}/ - file: reference/gpu_libraries/c++_primitives title: C++ Primitives subtrees: diff --git a/docs/reference/gpu_libraries/blas.md b/docs/reference/gpu_libraries/blas.md deleted file mode 100644 index cba0f6a9e..000000000 --- a/docs/reference/gpu_libraries/blas.md +++ /dev/null @@ -1,49 +0,0 @@ -# Matrix Multiplication - -ROCm libraries for BLAS are as follows: - -:::::{grid} 1 1 2 2 -:gutter: 1 - -:::{grid-item-card} hipBLAS -hipBLAS is a compatiblity layer for GPU accelerated BLAS optimized for AMD GPUs -via rocBLAS and rocSOLVER. hipBLAS allows for a common interface for other GPU -BLAS libraries. - -- [API Reference Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/rtd/) -- [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLAS/blob/develop/CHANGELOG.md) - -::: - -:::{grid-item-card} rocBLAS -rocBLAS is an AMD GPU optimized library for BLAS. - -- [API Reference Manual](https://rocmdocs.amd.com/projects/rocBLAS/en/rtd/) -- [Changelog](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/CHANGELOG.md) -- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocBLAS) - -::: - -:::{grid-item-card} Tensile -Tensile is a tool for creating benchmark-driven backend libraries for GEMMs, -GEMM-like problems and general N-dimensional tensor contractions on a GPU. -The Tensile library is mainly used as backend library to rocBLAS. Tensile acts as the -performance backbone for a wide variety of 'compute' applications running on AMD GPUs. - -- [API Reference Manual](https://rocmdocs.amd.com/projects/rocBLAS/en/rtd/) -- [Changelog](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/CHANGELOG.md) -- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocBLAS) - -::: - -:::{grid-item-card} rocWMMA -AMD's C++ library for accelerating mixed-precision matrix multiply-accumulate (MMA) -operations leveraging AMD GPU hardware. - -- [API Reference Manual](https://docs.amd.com/bundle/rocWMMA-release-rocm-rel-5.2/page/API_Reference_Guide.html) -- [Changelog](https://github.com/ROCmSoftwarePlatform/rocWMMA/blob/develop/CHANGELOG.md) -- [Examples](https://github.com/ROCmSoftwarePlatform/rocWMMA/tree/develop/samples) - -::: - -::::: diff --git a/docs/reference/gpu_libraries/linear_algebra.md b/docs/reference/gpu_libraries/linear_algebra.md new file mode 100644 index 000000000..744f86e72 --- /dev/null +++ b/docs/reference/gpu_libraries/linear_algebra.md @@ -0,0 +1,81 @@ +# Linear Algebra Libraries + +ROCm libraries for linear algebra are as follows: + +:::::{grid} 1 1 2 2 +:gutter: 1 + +:::{grid-item-card} hipBLAS +hipBLAS is a compatiblity layer for GPU accelerated BLAS optimized for AMD GPUs +via rocBLAS and rocSOLVER. hipBLAS allows for a common interface for other GPU +BLAS libraries. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/rtd/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLAS/blob/develop/CHANGELOG.md) + +::: + +:::{grid-item-card} rocBLAS +rocBLAS is an AMD GPU optimized library for BLAS. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/rocBLAS/en/rtd/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/CHANGELOG.md) +- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocBLAS) + +::: + +:::{grid-item-card} rocSPARSE +rocSPARSE is a sparse matrix solver for AMD GPU backends. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/rocSPARSE/en/rtd/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/rocSPARSE/blob/develop/CHANGELOG.md) + +::: + +:::{grid-item-card} hipSPARSE +hipSPARSE is sparse matrix solver library that support AMD and NVIDIA GPU backends. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/hipSPARSE/en/rtd/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/hipSPARSE/blob/develop/CHANGELOG.md) + +::: + +:::{grid-item-card} rocALUTION +rocBLAS is an AMD GPU optimized library for BLAS. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/rocALUTION/en/rtd/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/rocALUTION/blob/develop/CHANGELOG.md) + +::: + +:::{grid-item-card} rocWMMA +AMD's C++ library for accelerating mixed-precision matrix multiply-accumulate (MMA) +operations leveraging AMD GPU hardware. + +- [API Reference Manual](https://docs.amd.com/bundle/rocWMMA-release-rocm-rel-5.2/page/API_Reference_Guide.html) +- [Changelog](https://github.com/ROCmSoftwarePlatform/rocWMMA/blob/develop/CHANGELOG.md) +- [Examples](https://github.com/ROCmSoftwarePlatform/rocWMMA/tree/develop/samples) + +::: + +:::{grid-item-card} rocSOLVER +rocSOLVER is a work-in-progress implementation of a subset of LAPACK functionality on the ROCm platform. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/rocSOLVER/en/rtd/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/rocSOLVER/blob/develop/CHANGELOG.md) +- [Examples](https://github.com/ROCmSoftwarePlatform/rocSOLVER/tree/develop/clients/samples) + +::: + +:::{grid-item-card} hipSOLVER +hipSOLVER is a LAPACK marshalling library, with multiple supported backends. It sits between the +application and a 'worker' LAPACK library, marshalling inputs into the backend library and marshalling +results back to the application. + +- [API Reference Manual](https://rocmdocs.amd.com/projects/hipSOLVER/en/rtd/) +- [Changelog](https://github.com/ROCmSoftwarePlatform/hipSOLVER/blob/develop/CHANGELOG.md) +- [Examples](https://github.com/ROCmSoftwarePlatform/hipSOLVER/tree/develop/clients/samples) + +::: + +:::::