diff --git a/docs/index.md b/docs/index.md index 7a1201726..20bbfc47a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,53 +5,34 @@ reference, ROCm, AMD"> -# AMD ROCm™ documentation +# AMD ROCm documentation -Welcome to the ROCm docs home page! If you're new to ROCm, you can review the following -resources to learn more about our products and what we support: +ROCm is an open-source software platform optimized to extract HPC and AI workload +performance from AMD Instinct accelerators and AMD Radeon GPUs while maintaining +compatibility with industry software frameworks. For more information, see [What is ROCm?](./what-is-rocm.rst) -* [What is ROCm?](./what-is-rocm.rst) -* [Release notes](./about/release-notes.md) +If you're using Radeon GPUs, consider reviewing {doc}`Radeon-specific ROCm documentation`. -You can install ROCm on our Radeon™, Radeon™ PRO, and Instinct™ GPUs. If you're using Radeon -GPUs, we recommend reading the -{doc}`Radeon-specific ROCm documentation`. +Installation instructions are available from: -For hands-on applications, refer to our [ROCm blogs](https://rocm.blogs.amd.com/) site. +* {doc}`ROCm installation for Linux` +* {doc}`HIP SDK installation for Windows` +* [Deep learning frameworks installation](./how-to/deep-learning-rocm.rst) -Our documentation is organized into the following categories: +ROCm documentation is organized into the following categories: ::::{grid} 1 2 2 2 :class-container: rocm-doc-grid :::{grid-item-card} -:img-top: ./data/banner-installation.jpg -:img-alt: Install documentation -:padding: 2 - -* Linux - * {doc}`Quick start guide` - * {doc}`Linux install guide` - * {doc}`Package manager integration` - * {doc}`Install Docker containers` - * {doc}`ROCm & Spack` -* Windows - * {doc}`Windows install guide` - * {doc}`Application deployment guidelines` -* [Deep learning frameworks](./how-to/deep-learning-rocm.rst) - * {doc}`PyTorch for ROCm` - * {doc}`TensorFlow for ROCm` - * {doc}`JAX for ROCm` -::: - -:::{grid-item-card} +:class-card: sd-text-black :img-top: ./data/banner-compatibility.jpg :img-alt: Compatibility information :padding: 2 * [Compatibility matrix](./compatibility/compatibility-matrix.rst) -* {doc}`System requirements (Linux)` -* {doc}`System requirements (Windows)` +* {doc}`Linux system requirements` +* {doc}`Windows system requirements` * {doc}`Third-party support` * {doc}`User/kernel space` * {doc}`Docker` @@ -60,28 +41,8 @@ Our documentation is organized into the following categories: * {doc}`ROCm on Radeon GPUs` ::: - -:::{grid-item-card} -:img-top: ./data/banner-reference.jpg -:img-alt: Reference documentation -:padding: 2 - -* [API libraries](./reference/api-libraries.md) - * [Artificial intelligence](#artificial-intelligence-apis) - * [C++ primitives](#cpp-primitives) - * [Communication](#communication-libraries) - * [Math](#math-apis) - * [Random number generators](#random-number-apis) - * [HIP runtime](#hip-runtime) -* [Tools](./reference/rocm-tools.md) - * [Development](#development-tools) - * [Performance analysis](#performance-analysis) - * [System](#system-tools) -* [Hardware specifications](./reference/gpu-arch-specs.rst) -::: - - :::{grid-item-card} +:class-card: sd-text-black :img-top: ./data/banner-howto.jpg :img-alt: How-to documentation :padding: 2 @@ -90,28 +51,20 @@ Our documentation is organized into the following categories: * [Using ROCm for HPC](./how-to/rocm-for-hpc/index.rst) * [Fine-tuning LLMs and inference optimization](./how-to/llm-fine-tuning-optimization/index.rst) * [System tuning for various architectures](./how-to/tuning-guides.md) - * [MI100](./how-to/tuning-guides/mi100.md) - * [MI200](./how-to/tuning-guides/mi200.md) - * [RDNA2](./how-to/tuning-guides/w6000-v620.md) * [GPU-enabled MPI](./how-to/gpu-enabled-mpi.rst) -* [Using compiler features](./conceptual/compiler-topics.md) - * [ROCm compiler infrastructure](https://rocm.docs.amd.com/projects/llvm-project/en/latest/index.html) - * [Using AddressSanitizer](https://rocm.docs.amd.com/projects/llvm-project/en/latest/conceptual/using-gpu-sanitizer.html) - * [OpenMP support](https://rocm.docs.amd.com/projects/llvm-project/en/latest/conceptual/openmp.html) +* [Using advanced compiler features](./conceptual/compiler-topics.md) * [Setting the number of CUs](./how-to/setting-cus) * [System level debugging](./how-to/system-debugging.md) * [GitHub examples](https://github.com/amd/rocm-examples) ::: :::{grid-item-card} +:class-card: sd-text-black :img-top: ./data/banner-conceptual.jpg :img-alt: Conceptual documentation :padding: 2 * [GPU architecture](./conceptual/gpu-arch.md) - * [MI100](./conceptual/gpu-arch/mi100.md) - * [MI250](./conceptual/gpu-arch/mi250.md) - * [MI300](./conceptual/gpu-arch/mi300.md) * [GPU memory](./conceptual/gpu-memory.md) * [File structure (Linux FHS)](./conceptual/file-reorg.md) * [GPU isolation techniques](./conceptual/gpu-isolation.md) @@ -121,4 +74,23 @@ Our documentation is organized into the following categories: * [Inference optimization with MIGraphX](./conceptual/ai-migraphx-optimization.md) ::: + +:::{grid-item-card} +:class-card: sd-text-black +:img-top: ./data/banner-reference.jpg +:img-alt: Reference documentation +:padding: 2 + +* [Libraries](./reference/api-libraries.md) + * [Artificial intelligence](#artificial-intelligence-apis) + * [C++ primitives](#cpp-primitives) + * [Communication](#communication-libraries) + * [Math](#math-apis) + * [Random number generators](#random-number-apis) + * [HIP runtime](#hip-runtime) +* [ROCm tools and compilers](./reference/rocm-tools.md) +* [GPU hardware specifications](./reference/gpu-arch-specs.rst) +::: + + :::: diff --git a/docs/reference/api-libraries.md b/docs/reference/api-libraries.md index b3eb9c702..37cb6bb15 100644 --- a/docs/reference/api-libraries.md +++ b/docs/reference/api-libraries.md @@ -6,7 +6,7 @@ algebra, AMD"> -# ROCm API libraries +# ROCm libraries ::::{grid} 1 2 2 2 :class-container: rocm-doc-grid diff --git a/docs/reference/rocm-tools.md b/docs/reference/rocm-tools.md index 7c2c0ce0b..3707d60f3 100644 --- a/docs/reference/rocm-tools.md +++ b/docs/reference/rocm-tools.md @@ -6,7 +6,7 @@ algebra, AMD"> -# ROCm tools +# ROCm tools and compilers ::::{grid} 1 2 2 2 :class-container: rocm-doc-grid diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 74d68120e..940c0fb17 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -9,6 +9,10 @@ subtrees: - file: what-is-rocm.rst - file: about/release-notes.md title: Release notes + subtrees: + - entries: + - file: about/changelog.md + title: Changelog - url: https://github.com/ROCm/ROCm/labels/Verified%20Issue title: Known issues @@ -21,28 +25,6 @@ subtrees: - file: how-to/deep-learning-rocm.md title: Deep learning frameworks -- caption: Compatibility - entries: - - file: compatibility/compatibility-matrix.rst - title: Compatibility matrix - - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/system-requirements.html - title: Linux - - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/reference/system-requirements.html - title: Windows - - file: compatibility/precision-support.rst - title: Precision support - - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/3rd-party-support-matrix.html - title: Third-party - -- caption: Reference - entries: - - file: reference/api-libraries.md - title: API libraries - - file: reference/rocm-tools.md - title: Tools - - file: reference/gpu-arch-specs.rst - title: Hardware specifications - - caption: How to entries: - file: how-to/rocm-for-ai/index.rst @@ -90,7 +72,7 @@ subtrees: - file: how-to/gpu-enabled-mpi.rst title: Using MPI - file: conceptual/compiler-topics.md - title: Using compiler features + title: Using advanced compiler features subtrees: - entries: - url: https://rocm.docs.amd.com/projects/llvm-project/en/latest/index.html @@ -106,6 +88,19 @@ subtrees: - url: https://github.com/amd/rocm-examples title: GitHub examples +- caption: Compatibility + entries: + - file: compatibility/compatibility-matrix.rst + title: Compatibility matrix + - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/system-requirements.html + title: Linux + - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/reference/system-requirements.html + title: Windows + - file: compatibility/precision-support.rst + title: Precision support + - url: https://rocm.docs.amd.com/projects/install-on-linux/en/${branch}/reference/3rd-party-support-matrix.html + title: Third-party + - caption: Conceptual entries: - file: conceptual/gpu-arch.md @@ -153,6 +148,15 @@ subtrees: - file: conceptual/ai-migraphx-optimization.md title: Inference optimization with MIGraphX +- caption: Reference + entries: + - file: reference/api-libraries.md + title: ROCm libraries + - file: reference/rocm-tools.md + title: Tools and compilers + - file: reference/gpu-arch-specs.rst + title: Hardware specifications + - caption: Contribute entries: - file: contribute/contributing.md