diff --git a/.wordlist.txt b/.wordlist.txt index 9d0f4d6cc..09236fa95 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -124,6 +124,7 @@ ENDPGM EPYC ESXi EoS +fas FBGEMM FFT FFTs @@ -196,6 +197,7 @@ HWE HWS Haswell Higgs +href Hyperparameters Huggingface ICD diff --git a/docs/how-to/deep-learning-rocm.rst b/docs/how-to/deep-learning-rocm.rst index beab5c1c8..16dad363c 100644 --- a/docs/how-to/deep-learning-rocm.rst +++ b/docs/how-to/deep-learning-rocm.rst @@ -2,58 +2,132 @@ :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 -******************************************** +********************************** +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, and JAX. ROCm works closely with these -frameworks to ensure that framework-specific optimizations take advantage of AMD accelerator and GPU architectures. +Deep learning frameworks provide environments for machine learning, training, fine-tuning, inference, and performance optimization. -The following guides provide information on compatibility and supported -features for these ROCm-enabled deep learning frameworks. +ROCm offers a complete ecosystem for developing and running deep learning applications efficiently. It also provides ROCm-compatible versions of popular frameworks and libraries, such as PyTorch, TensorFlow, JAX, and others. -* :doc:`PyTorch compatibility <../compatibility/ml-compatibility/pytorch-compatibility>` -* :doc:`TensorFlow compatibility <../compatibility/ml-compatibility/tensorflow-compatibility>` -* :doc:`JAX compatibility <../compatibility/ml-compatibility/jax-compatibility>` -* :doc:`verl compatibility <../compatibility/ml-compatibility/verl-compatibility>` -* :doc:`Stanford Megatron-LM compatibility <../compatibility/ml-compatibility/stanford-megatron-lm-compatibility>` -* :doc:`DGL compatibility <../compatibility/ml-compatibility/dgl-compatibility>` -* :doc:`Megablocks compatibility <../compatibility/ml-compatibility/megablocks-compatibility>` -* :doc:`Taichi compatibility <../compatibility/ml-compatibility/taichi-compatibility>` +The AMD ROCm organization actively contributes to open-source development and collaborates closely with framework organizations. This collaboration ensures that framework-specific optimizations effectively leverage AMD GPUs and accelerators. -This chart steps through typical installation workflows for installing deep learning frameworks for ROCm. +The table below summarizes information about ROCm-enabled deep learning frameworks. It includes details on ROCm compatibility and third-party tool support, installation steps and options, and links to GitHub resources. For a complete list of supported framework versions on ROCm, see the :doc:`Compatibility matrix <../compatibility/compatibility-matrix>` topic. -.. image:: ../data/how-to/framework_install_2024_07_04.png - :alt: Flowchart for installing ROCm-aware machine learning frameworks - :align: center +.. list-table:: + :header-rows: 1 + :widths: 5 3 6 3 -See the installation instructions to get started. + * - Framework + - Installation + - Installation options + - GitHub -* :doc:`PyTorch for ROCm ` -* :doc:`TensorFlow for ROCm ` -* :doc:`JAX for ROCm ` -* :doc:`verl for ROCm ` -* :doc:`Stanford Megatron-LM for ROCm ` -* :doc:`DGL for ROCm ` -* :doc:`Megablocks for ROCm ` -* :doc:`Taichi for ROCm ` + * - `PyTorch `_ + - .. raw:: html + + + - + - `Docker image `_ + - `Wheels package `_ + - `ROCm Base Docker image `_ + - `Upstream Docker file `_ + - .. raw:: html + + + + * - `TensorFlow `_ + - .. raw:: html + + + - + - `Docker image `_ + - `Wheels package `_ -.. note:: + - .. raw:: html + + + + * - `JAX `_ + - .. raw:: html + + + - + - `Docker image `_ + - .. raw:: html + + + + * - `verl `_ + - .. raw:: html + + + - + - `Docker image `_ + - .. raw:: html + + + + * - `Stanford Megatron-LM `_ + - .. raw:: html + + + - + - `Docker image `_ + - .. raw:: html + + + + * - `DGL `_ + - .. raw:: html + + + - + - `Docker image `_ + - .. raw:: html + + + + * - `Megablocks `_ + - .. raw:: html + + + - + - `Docker image `_ + - .. raw:: html + + + + * - `Taichi `_ + - .. raw:: html + + + - + - `Docker image `_ + - `Wheels package `_ + + - .. raw:: html + + - For guidance on installing ROCm itself, refer to :doc:`ROCm installation for Linux `. Learn how to use your ROCm deep learning environment for training, fine-tuning, inference, and performance optimization through the following guides. * :doc:`rocm-for-ai/index` -* :doc:`Training ` +* :doc:`Use ROCm for training ` + +* :doc:`Use ROCm for fine-tuning LLMs ` + +* :doc:`Use ROCm for AI inference ` + +* :doc:`Use ROCm for AI inference optimization ` + + + + -* :doc:`Fine-tuning LLMs ` -* :doc:`Inference ` -* :doc:`Inference optimization ` diff --git a/docs/how-to/rocm-for-ai/install.rst b/docs/how-to/rocm-for-ai/install.rst index d9c9c345d..6847d06b4 100644 --- a/docs/how-to/rocm-for-ai/install.rst +++ b/docs/how-to/rocm-for-ai/install.rst @@ -1,14 +1,14 @@ .. meta:: - :description: How to install ROCm and popular machine learning frameworks. + :description: How to install ROCm and popular deep learning frameworks. :keywords: ROCm, AI, LLM, train, fine-tune, FSDP, DeepSpeed, LLaMA, tutorial .. _rocm-for-ai-install: -*********************************************** -Installing ROCm and machine learning frameworks -*********************************************** +******************************************** +Installing ROCm and deep learning frameworks +******************************************** -Before getting started, install ROCm and supported machine learning frameworks. +Before getting started, install ROCm and supported deep learning frameworks. .. grid:: 1 @@ -43,29 +43,16 @@ distribution's package manager. See the following documentation resources to get If you encounter any issues during installation, refer to the :doc:`Installation troubleshooting ` guide. -Machine learning frameworks -=========================== +Deep learning frameworks +======================== -ROCm supports popular machine learning frameworks and libraries including `PyTorch +ROCm supports deep learning frameworks and libraries including `PyTorch `_, `TensorFlow -`_, `JAX `_, and `DeepSpeed -`_. +`_, `JAX `_, and more. -Review the framework installation documentation. For ease-of-use, it's recommended to use official ROCm prebuilt Docker +Review the :doc:`framework installation documentation <../deep-learning-rocm>`. For ease-of-use, it's recommended to use official ROCm prebuilt Docker images with the framework pre-installed. -* :doc:`PyTorch for ROCm ` - -* :doc:`TensorFlow for ROCm ` - -* :doc:`JAX for ROCm ` - -* :doc:`verl for ROCm ` - -* :doc:`Stanford Megatron-LM for ROCm ` - -* :doc:`DGL for ROCm ` - Next steps ========== diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index db786f0c4..1bb9177f0 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -27,6 +27,24 @@ subtrees: title: ROCm on Radeon GPUs - file: how-to/deep-learning-rocm.md title: Deep learning frameworks + subtrees: + - entries: + - file: compatibility/ml-compatibility/pytorch-compatibility.rst + title: PyTorch compatibility + - file: compatibility/ml-compatibility/tensorflow-compatibility.rst + title: TensorFlow compatibility + - file: compatibility/ml-compatibility/jax-compatibility.rst + title: JAX compatibility + - file: compatibility/ml-compatibility/verl-compatibility.rst + title: verl compatibility + - file: compatibility/ml-compatibility/stanford-megatron-lm-compatibility.rst + title: Stanford Megatron-LM compatibility + - file: compatibility/ml-compatibility/dgl-compatibility.rst + title: DGL compatibility + - file: compatibility/ml-compatibility/megablocks-compatibility.rst + title: Megablocks compatibility + - file: compatibility/ml-compatibility/taichi-compatibility.rst + title: Taichi compatibility - file: how-to/build-rocm.rst title: Build ROCm from source