Add TensorFlow compatibility docs (ROCm#4247)

* Add Tensorflow * WIP * WIP * minor fmt * PR feedbacks * fix missed inconsistent formatting * WIP WIP WIP WIP * minor formatting update tensorflow-rocm docker images to rocm6.3.1 fix urls * WIP * fix typo and update wordlist * fix tables not rendering * fix table headings * add period * update tf dockers * fix link * fix link * wording * update historical compat * fix tensile link --------- Co-authored-by: Mátyás Aradi <[email protected]> Co-authored-by: Istvan Kiss <[email protected]> (cherry picked from commit 26553d7)
peterjunpark · Jan 9, 2025 · 8e67459 · 8e67459
1 parent f2962df
commit 8e67459
Show file tree

Hide file tree

Showing 8 changed files with 520 additions and 29 deletions.
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -151,8 +151,9 @@ HCA
 HGX
 HIPCC
 HIPExtension
-HIPification
 HIPIFY
+HIPification
+HIPify
 HPC
 HPCG
 HPE
@@ -250,6 +251,7 @@ MyST
 NBIO
 NBIOs
 NCCL
+NCF
 NIC
 NICs
 NLI
@@ -711,6 +713,7 @@ protobuf
 pseudorandom
 py
 recommender
+recommenders
 quantile
 quantizer
 quasirandom

diff --git a/docs/compatibility/compatibility-matrix-historical-6.0.csv b/docs/compatibility/compatibility-matrix-historical-6.0.csv
@@ -22,9 +22,9 @@ ROCm Version,6.3.1,6.3.0,6.2.4,6.2.2,6.2.1,6.2.0, 6.1.2, 6.1.1, 6.1.0, 6.0.2, 6.
       ,gfx908,gfx908,gfx908,gfx908,gfx908,gfx908,gfx908,gfx908,gfx908,gfx908,gfx908
       ,,,,,,,,,,,
       FRAMEWORK SUPPORT,.. _framework-support-compatibility-matrix-past-60:,,,,,,,,,,
-      :doc:`PyTorch <../compatibility/pytorch-compatibility>`,"2.4, 2.3, 2.2, 2.1, 2.0, 1.13","2.4, 2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13","2.1, 2.0, 1.13","2.1, 2.0, 1.13","2.1, 2.0, 1.13","2.1, 2.0, 1.13","2.1, 2.0, 1.13"
-      :doc:`TensorFlow <rocm-install-on-linux:install/3rd-party/tensorflow-install>`,"2.17.0, 2.16.2, 2.15.1","2.17.0, 2.16.2, 2.15.1","2.16.1, 2.15.1, 2.14.1","2.16.1, 2.15.1, 2.14.1","2.16.1, 2.15.1, 2.14.1","2.16.1, 2.15.1, 2.14.1","2.15.0, 2.14.0, 2.13.1","2.15.0, 2.14.0, 2.13.1","2.15.0, 2.14.0, 2.13.1","2.14.0, 2.13.1, 2.12.1","2.14.0, 2.13.1, 2.12.1"
-      :doc:`JAX <rocm-install-on-linux:install/3rd-party/jax-install>`,0.4.31,0.4.31,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26
+      :doc:`PyTorch <../compatibility/ml-compatibility/pytorch-compatibility>`,"2.4, 2.3, 2.2, 2.1, 2.0, 1.13","2.4, 2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13","2.1, 2.0, 1.13","2.1, 2.0, 1.13","2.1, 2.0, 1.13","2.1, 2.0, 1.13","2.1, 2.0, 1.13"
+      :doc:`TensorFlow <../compatibility/ml-compatibility/tensorflow-compatibility>`,"2.17.0, 2.16.2, 2.15.1","2.17.0, 2.16.2, 2.15.1","2.16.1, 2.15.1, 2.14.1","2.16.1, 2.15.1, 2.14.1","2.16.1, 2.15.1, 2.14.1","2.16.1, 2.15.1, 2.14.1","2.15.0, 2.14.0, 2.13.1","2.15.0, 2.14.0, 2.13.1","2.15.0, 2.14.0, 2.13.1","2.14.0, 2.13.1, 2.12.1","2.14.0, 2.13.1, 2.12.1"
+      :doc:`JAX <../compatibility/ml-compatibility/jax-compatibility>`,0.4.31,0.4.31,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26,0.4.26
       `ONNX Runtime <https://onnxruntime.ai/docs/build/eps.html#amd-migraphx>`_,1.17.3,1.17.3,1.17.3,1.17.3,1.17.3,1.17.3,1.17.3,1.17.3,1.17.3,1.14.1,1.14.1
       ,,,,,,,,,,,
       THIRD PARTY COMMS,.. _thirdpartycomms-support-compatibility-matrix-past-60:,,,,,,,,,,
@@ -71,7 +71,7 @@ ROCm Version,6.3.1,6.3.0,6.2.4,6.2.2,6.2.1,6.2.0, 6.1.2, 6.1.1, 6.1.0, 6.0.2, 6.
       :doc:`rocSOLVER <rocsolver:index>`,3.27.0,3.27.0,3.26.2,3.26.0,3.26.0,3.26.0,3.25.0,3.25.0,3.25.0,3.24.0,3.24.0
       :doc:`rocSPARSE <rocsparse:index>`,3.3.0,3.3.0,3.2.1,3.2.0,3.2.0,3.2.0,3.1.2,3.1.2,3.1.2,3.0.2,3.0.2
       :doc:`rocWMMA <rocwmma:index>`,1.6.0,1.6.0,1.5.0,1.5.0,1.5.0,1.5.0,1.4.0,1.4.0,1.4.0,1.3.0,1.3.0
-      :doc:`Tensile <tensile:index>`,4.42.0,4.42.0,4.41.0,4.41.0,4.41.0,4.41.0,4.40.0,4.40.0,4.40.0,4.39.0,4.39.0
+      :doc:`Tensile <tensile:src/index>`,4.42.0,4.42.0,4.41.0,4.41.0,4.41.0,4.41.0,4.40.0,4.40.0,4.40.0,4.39.0,4.39.0
       ,,,,,,,,,,,
       PRIMITIVES,.. _primitivelibs-support-compatibility-matrix-past-60:,,,,,,,,,,
       :doc:`hipCUB <hipcub:index>`,3.3.0,3.3.0,3.2.1,3.2.0,3.2.0,3.2.0,3.1.0,3.1.0,3.1.0,3.0.0,3.0.0

diff --git a/docs/compatibility/compatibility-matrix.rst b/docs/compatibility/compatibility-matrix.rst
@@ -48,7 +48,7 @@ compatibility and system requirements.
       ,,,
       FRAMEWORK SUPPORT,.. _framework-support-compatibility-matrix:,,
       :doc:`PyTorch <../compatibility/ml-compatibility/pytorch-compatibility>`,"2.4, 2.3, 2.2, 1.13","2.4, 2.3, 2.2, 2.1, 2.0, 1.13","2.3, 2.2, 2.1, 2.0, 1.13"
-      :doc:`TensorFlow <rocm-install-on-linux:install/3rd-party/tensorflow-install>`,"2.17.0, 2.16.2, 2.15.1","2.17.0, 2.16.2, 2.15.1","2.16.1, 2.15.1, 2.14.1"
+      :doc:`TensorFlow <../compatibility/ml-compatibility/tensorflow-compatibility>`,"2.17.0, 2.16.2, 2.15.1","2.17.0, 2.16.2, 2.15.1","2.16.1, 2.15.1, 2.14.1"
       :doc:`JAX <../compatibility/ml-compatibility/jax-compatibility>`,0.4.31,0.4.31,0.4.26
       `ONNX Runtime <https://onnxruntime.ai/docs/build/eps.html#amd-migraphx>`_,1.17.3,1.17.3,1.17.3
       ,,,
@@ -94,7 +94,7 @@ compatibility and system requirements.
       :doc:`rocSOLVER <rocsolver:index>`,3.27.0,3.27.0,3.26.0
       :doc:`rocSPARSE <rocsparse:index>`,3.3.0,3.3.0,3.2.0
       :doc:`rocWMMA <rocwmma:index>`,1.6.0,1.6.0,1.5.0
-      :doc:`Tensile <tensile:index>`,4.42.0,4.42.0,4.41.0
+      :doc:`Tensile <tensile:src/index>`,4.42.0,4.42.0,4.41.0
       ,,,
       PRIMITIVES,.. _primitivelibs-support-compatibility-matrix:,,
       :doc:`hipCUB <hipcub:index>`,3.3.0,3.3.0,3.2.0

diff --git a/docs/compatibility/ml-compatibility/jax-compatibility.rst b/docs/compatibility/ml-compatibility/jax-compatibility.rst
@@ -54,8 +54,8 @@ Docker image compatibility
 AMD validates and publishes ready-made `JAX <https://hub.docker.com/r/rocm/jax/>`_
 images with ROCm backends on Docker Hub. The following Docker image tags and
 associated inventories are validated for
-`ROCm 6.3.1 <https://repo.radeon.com/rocm/apt/6.3.1/>`_. Click |docker-icon|
-to see the image on Docker Hub.
+`ROCm 6.3.1 <https://repo.radeon.com/rocm/apt/6.3.1/>`_. Click the |docker-icon|
+icon to view the image on Docker Hub.
 
 .. list-table:: JAX Docker image components
     :header-rows: 1
@@ -605,7 +605,7 @@ ROCm.
 .. list-table::
     :header-rows: 1
 
-    * - Data type
+    * - Feature
       - Description
       - Since JAX
     * - Mixed Precision with TF32
@@ -660,5 +660,4 @@ Use cases and recommendations
   performance for deep learning and other high-performance computing tasks on
   the MI300X GPU.
 
-For more use cases and recommendations, see `ROCm JAX blog posts <https://rocm.blogs.amd.com/blog/tag/jax.html>`_
-
+For more use cases and recommendations, see `ROCm JAX blog posts <https://rocm.blogs.amd.com/blog/tag/jax.html>`_.
diff --git a/docs/compatibility/ml-compatibility/pytorch-compatibility.rst b/docs/compatibility/ml-compatibility/pytorch-compatibility.rst
@@ -40,7 +40,7 @@ The upstream PyTorch includes an automatic HIPification solution that automatica
 source code from the CUDA backend. This approach allows PyTorch to support ROCm without requiring
 manual code modifications.
 
-ROCm's development is aligned with the stable release of PyTorch while upstream PyTorch testing uses
+Development of ROCm is aligned with the stable release of PyTorch while upstream PyTorch testing uses
 the stable release of ROCm to maintain consistency.
 
 .. _pytorch-docker-compat:
@@ -55,7 +55,7 @@ Docker image compatibility
 AMD validates and publishes ready-made `PyTorch <https://hub.docker.com/r/rocm/pytorch>`_
 images with ROCm backends on Docker Hub. The following Docker image tags and
 associated inventories are validated for `ROCm 6.3.0 <https://repo.radeon.com/rocm/apt/6.3/>`_.
-Click |docker-icon| to see the image on Docker Hub.
+Click the |docker-icon| icon to view the image on Docker Hub.
 
 .. list-table:: PyTorch Docker image components
     :header-rows: 1
@@ -469,7 +469,7 @@ leveraging ROCm and CUDA as the underlying frameworks.
 .. list-table::
     :header-rows: 1
 
-    * - Data type
+    * - Feature
       - Description
       - Since PyTorch
       - Since ROCm
@@ -537,14 +537,14 @@ torch.backends.cuda
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ``torch.backends.cuda`` is a PyTorch module that provides configuration options
-and flags to control the behavior of CUDA or ROCm operations. It is part of the
+and flags to control the behavior of ROCm or CUDA operations. It is part of the
 PyTorch backend configuration system, which allows users to fine-tune how
-PyTorch interacts with the CUDA or ROCm environment.
+PyTorch interacts with the ROCm or CUDA environment.
 
 .. list-table::
     :header-rows: 1
 
-    * - Data type
+    * - Feature
       - Description
       - Since PyTorch
       - Since ROCm
@@ -588,12 +588,12 @@ PyTorch interacts with the CUDA or ROCm environment.
 torch.backends.cudnn
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Supported ``torch`` options:
+Supported ``torch`` options include:
 
 .. list-table::
     :header-rows: 1
 
-    * - Data type
+    * - Option
       - Description
       - Since PyTorch
       - Since ROCm
@@ -618,7 +618,7 @@ training and inference.
 .. list-table::
     :header-rows: 1
 
-    * - Data type
+    * - Feature
       - Description
       - Since PyTorch
       - Since ROCm
@@ -658,7 +658,7 @@ of computational resources and scalability for large-scale tasks.
 .. list-table::
     :header-rows: 1
 
-    * - Features
+    * - Feature
       - Description
       - Since PyTorch
       - Since ROCm
@@ -683,7 +683,7 @@ torch.compiler
 .. list-table::
     :header-rows: 1
 
-    * - Features
+    * - Feature
       - Description
       - Since PyTorch
       - Since ROCm
@@ -717,7 +717,7 @@ The following ``torchaudio`` features are GPU-accelerated.
 .. list-table::
     :header-rows: 1
 
-    * - Features
+    * - Feature
       - Description
       - Since torchaudio version
       - Since ROCm
@@ -750,7 +750,7 @@ The following ``torchvision`` features are GPU-accelerated.
 .. list-table::
     :header-rows: 1
 
-    * - Features
+    * - Feature
       - Description
       - Since torchvision version
       - Since ROCm
@@ -834,7 +834,7 @@ The following are GPU-accelerated PyTorch features not currently supported by RO
     :widths: 30, 60, 10
     :header-rows: 1
 
-    * - Data type
+    * - Feature
       - Description
       - Since PyTorch
     * - APEX batch norm
@@ -919,4 +919,4 @@ Use cases and recommendations
   describes how PyTorch integrates with ROCm for AI workloads It outlines the use of PyTorch on the ROCm platform and
   focuses on how to efficiently leverage AMD GPU hardware for training and inference tasks in AI applications.
 
-For more use cases and recommendations, see `ROCm PyTorch blog posts <https://rocm.blogs.amd.com/blog/tag/pytorch.html>`_
+For more use cases and recommendations, see `ROCm PyTorch blog posts <https://rocm.blogs.amd.com/blog/tag/pytorch.html>`_.