diff --git a/docs/data/how-to/framework_install_2024_05_23.png b/docs/data/how-to/framework_install_2024_05_23.png new file mode 100644 index 0000000000..363f30c07f Binary files /dev/null and b/docs/data/how-to/framework_install_2024_05_23.png differ diff --git a/docs/how-to/deep-learning-rocm.md b/docs/how-to/deep-learning-rocm.md deleted file mode 100644 index 5592d8d50a..0000000000 --- a/docs/how-to/deep-learning-rocm.md +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - -# 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 Compatible Frameworks Flowchart](../data/how-to/magma005.png "ROCm Compatible Frameworks") - -## Frameworks installation - -* {doc}`PyTorch for ROCm` -* {doc}`TensorFlow for ROCm` -* {doc}`MAGMA for ROCm` diff --git a/docs/how-to/deep-learning-rocm.rst b/docs/how-to/deep-learning-rocm.rst new file mode 100644 index 0000000000..5493be62e0 --- /dev/null +++ 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 ` 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 ` + + .. grid-item:: + :columns: 3 + + :doc:`TensorFlow for ROCm ` + + .. grid-item:: + :columns: 3 + + .. grid-item:: + :columns: 3 + + .. grid-item:: + :columns: 3 + + :doc:`JAX for ROCm ` + + .. grid-item:: + :columns: 3 + + :doc:`MAGMA for ROCm ` + + .. 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 +`. + +.. Learn how to take advantage of your ROCm-aware deep learning environment using the following tutorials. +.. +.. * :doc:`How to use ROCm for AI ` +.. +.. * :doc:`How to fine-tune LLMs with ROCm ` +.. + +.. note:: + + For guidance on installing ROCm itself, refer to :doc:`ROCm installation for Linux `. + diff --git a/docs/how-to/tuning-guides.md b/docs/how-to/tuning-guides.md index 18341db108..a1fbcc5cb0 100644 --- a/docs/how-to/tuning-guides.md +++ b/docs/how-to/tuning-guides.md @@ -1,13 +1,14 @@ - + -# 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 diff --git a/docs/index.md b/docs/index.md index 7eada8714e..dd30f50797 100644 --- 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` * {doc}`Application deployment guidelines` -* {doc}`Install Docker containers` -* {doc}`PyTorch for ROCm` -* {doc}`TensorFlow for ROCm` -* {doc}`JAX for ROCm` -* {doc}`MAGMA for ROCm` -* {doc}`ROCm & Spack` +* [Deep learning frameworks](./how-to/deep-learning-rocm.rst) + * {doc}`Install Docker containers` + * {doc}`PyTorch for ROCm` + * {doc}`TensorFlow for ROCm` + * {doc}`JAX for ROCm` + * {doc}`MAGMA for ROCm` + * {doc}`ROCm & 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) diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index ebb46ad4ed..11855b6a65 100644 --- 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