Reorg 'Deep learning' and 'Tuning guides' docs (#3153)

* Rename 'Tuning guides' to 'Hardware optimization' * Move deep learning to Install section * Change 'Hardware' to 'System' to align with index.md * Satisfy spellcheck linter * adding new framework install graphic with JAX * Fix link to ROCm libraries list * crop framework_install graphic * Reset .wordlist.txt update * Prettify deep learning framework installation page * Change spacing in list of frameworks --------- Co-authored-by: Young Hui <young.hui@amd.com>
2026-01-09 14:48:06 -05:00 · 2024-05-29 11:12:43 -07:00
parent bca631057b
commit fd337ac220
6 changed files with 83 additions and 35 deletions
--- a/docs/data/how-to/framework_install_2024_05_23.png
+++ b/docs/data/how-to/framework_install_2024_05_23.png
--- a/docs/how-to/deep-learning-rocm.md
+++ b/docs/how-to/deep-learning-rocm.md
@@ -1,22 +0,0 @@
-<head>
-  <meta charset="UTF-8">
-  <meta name="description" content="Deep learning using ROCm">
-  <meta name="keywords" content="deep learning, frameworks, installation, PyTorch, TensorFlow,
-  MAGMA, AMD, ROCm">
-</head>
-
-# Deep learning guide
-
-The following sections cover the different framework installations for ROCm and
-deep-learning applications. The following image provides
-the sequential flow for the use of each framework. Refer to the ROCm Compatible
-Frameworks Release Notes for each framework's most current release notes at
-{doc}`Third-party support<rocm-install-on-linux:reference/3rd-party-support-matrix>`.
-
-![ROCm Compatible Frameworks Flowchart](../data/how-to/magma005.png "ROCm Compatible Frameworks")
-
-## Frameworks installation
-
-* {doc}`PyTorch for ROCm<rocm-install-on-linux:how-to/3rd-party/pytorch-install>`
-* {doc}`TensorFlow for ROCm<rocm-install-on-linux:how-to/3rd-party/tensorflow-install>`
-* {doc}`MAGMA for ROCm<rocm-install-on-linux:how-to/3rd-party/magma-install>`
--- a/docs/how-to/deep-learning-rocm.rst
+++ b/docs/how-to/deep-learning-rocm.rst
@@ -0,0 +1,69 @@
+.. meta::
+   :description: How to install deep learning frameworks for ROCm
+   :keywords: deep learning, frameworks, ROCm, install, PyTorch, TensorFlow, JAX, MAGMA, DeepSpeed, ML, AI
+
+********************************************
+Installing deep learning frameworks for ROCm
+********************************************
+
+ROCm provides a comprehensive ecosystem for deep learning development, including
+:ref:`libraries <artificial-intelligence-apis>` for optimized deep learning operations and ROCm-aware versions of popular
+deep learning frameworks and libraries such as PyTorch, TensorFlow, JAX, and MAGMA. ROCm works closely with these
+frameworks to ensure that framework-specific optimizations take advantage of AMD accelerator and GPU architectures.
+
+The following guides cover installation processes for ROCm-aware deep learning frameworks.
+
+.. grid::
+
+   .. grid-item::
+      :columns: 3
+
+      :doc:`PyTorch for ROCm <rocm-install-on-linux:how-to/3rd-party/pytorch-install>`
+
+   .. grid-item::
+      :columns: 3
+
+      :doc:`TensorFlow for ROCm <rocm-install-on-linux:how-to/3rd-party/tensorflow-install>`
+
+   .. grid-item::
+      :columns: 3
+
+   .. grid-item::
+      :columns: 3
+
+   .. grid-item::
+      :columns: 3
+
+      :doc:`JAX for ROCm <rocm-install-on-linux:how-to/3rd-party/jax-install>`
+
+   .. grid-item::
+      :columns: 3
+
+      :doc:`MAGMA for ROCm <rocm-install-on-linux:how-to/3rd-party/magma-install>`
+
+   .. grid-item::
+      :columns: 3
+
+   .. grid-item::
+      :columns: 3
+
+The following chart steps through typical installation workflows for installing deep learning frameworks for ROCm.
+
+.. image:: ../data/how-to/framework_install_2024_05_23.png
+   :alt: Flowchart for installing ROCm-aware machine learning frameworks
+   :align: center
+
+Find information on version compatibility and framework release notes in :doc:`Third-party support matrix
+<rocm-install-on-linux:reference/3rd-party-support-matrix>`.
+
+.. Learn how to take advantage of your ROCm-aware deep learning environment using the following tutorials.
+..
+..    * :doc:`How to use ROCm for AI <how-to/rocm-for-ai/index>`
+..
+..    * :doc:`How to fine-tune LLMs with ROCm <how-to/fine-tuning-llms/index>`
+..
+
+.. note::
+
+   For guidance on installing ROCm itself, refer to :doc:`ROCm installation for Linux <rocm-install-on-linux:index>`.
+
--- a/docs/how-to/tuning-guides.md
+++ b/docs/how-to/tuning-guides.md
@@ -1,13 +1,14 @@
 <head>
  <meta charset="UTF-8">
-  <meta name="description" content="Tuning guides">
+  <meta name="description" content="AMD hardware optimization for specific workloads">
  <meta name="keywords" content="high-performance computing, HPC, Instinct accelerators,
  Radeon, tuning, tuning guide, AMD, ROCm">
 </head>

-# Tuning guides
+# System optimization

-Use case-specific system setup and tuning guides.
+This guide outlines system setup and tuning suggestions for AMD hardware to optimize performance for specific types of
+workloads or use-cases.

 ## High-performance computing

--- a/docs/index.md
+++ b/docs/index.md
@@ -37,12 +37,13 @@ Our documentation is organized into the following categories:
 * Windows
  * {doc}`Windows install guide<rocm-install-on-windows:how-to/install>`
  * {doc}`Application deployment guidelines<rocm-install-on-windows:conceptual/deployment-guidelines>`
-* {doc}`Install Docker containers<rocm-install-on-linux:how-to/docker>`
-* {doc}`PyTorch for ROCm<rocm-install-on-linux:how-to/3rd-party/pytorch-install>`
-* {doc}`TensorFlow for ROCm<rocm-install-on-linux:how-to/3rd-party/tensorflow-install>`
-* {doc}`JAX for ROCm<rocm-install-on-linux:how-to/3rd-party/jax-install>`
-* {doc}`MAGMA for ROCm<rocm-install-on-linux:how-to/3rd-party/magma-install>`
-* {doc}`ROCm & Spack<rocm-install-on-linux:how-to/spack>`
+* [Deep learning frameworks](./how-to/deep-learning-rocm.rst)
+  * {doc}`Install Docker containers<rocm-install-on-linux:how-to/docker>`
+  * {doc}`PyTorch for ROCm<rocm-install-on-linux:how-to/3rd-party/pytorch-install>`
+  * {doc}`TensorFlow for ROCm<rocm-install-on-linux:how-to/3rd-party/tensorflow-install>`
+  * {doc}`JAX for ROCm<rocm-install-on-linux:how-to/3rd-party/jax-install>`
+  * {doc}`MAGMA for ROCm<rocm-install-on-linux:how-to/3rd-party/magma-install>`
+  * {doc}`ROCm & Spack<rocm-install-on-linux:how-to/spack>`
 :::

 :::{grid-item-card}
@@ -94,7 +95,6 @@ Our documentation is organized into the following categories:
  * [MI100](./how-to/tuning-guides/mi100.md)
  * [MI200](./how-to/tuning-guides/mi200.md)
  * [RDNA2](./how-to/tuning-guides/w6000-v620.md)
-* [Setting up for deep learning with ROCm](./how-to/deep-learning-rocm.md)
 * [GPU-enabled MPI](./how-to/gpu-enabled-mpi.rst)
 * [Using compiler features](./conceptual/compiler-topics.md)
  * [Using AddressSanitizer](./conceptual/using-gpu-sanitizer.md)
--- a/docs/sphinx/_toc.yml.in
+++ b/docs/sphinx/_toc.yml.in
@@ -22,6 +22,8 @@ subtrees:
    title: ROCm on Linux
  - url: https://rocm.docs.amd.com/projects/install-on-windows/en/${branch}/
    title: HIP SDK on Windows
+  - file: how-to/deep-learning-rocm.md
+    title: Deep learning frameworks

 - caption: Compatibility
  entries:
@@ -48,7 +50,7 @@ subtrees:
 - caption: How to
  entries:
  - file: how-to/tuning-guides.md
-    title: Tuning guides
+    title: System optimization
    subtrees:
    - entries:
      - file: how-to/tuning-guides/mi100.md
@@ -57,8 +59,6 @@ subtrees:
        title: MI200
      - file: how-to/tuning-guides/w6000-v620.md
        title: RDNA2
-  - file: how-to/deep-learning-rocm.md
-    title: Deep learning
  - file: how-to/gpu-enabled-mpi.rst
    title: Using MPI
  - file: conceptual/compiler-topics.md