From ee659d5512695dc6e6d492137033babfc81aba0d Mon Sep 17 00:00:00 2001 From: im-AbhiP Date: Tue, 3 Jun 2025 10:30:58 -0700 Subject: [PATCH 1/3] System requirements modified. Fixed the doc issue #37 --- docs/container-runtime/quick-start-guide.rst | 2 +- docs/container-runtime/release-notes.rst | 3 --- docs/container-runtime/requirements.rst | 25 +++++++------------- 3 files changed, 9 insertions(+), 21 deletions(-) diff --git a/docs/container-runtime/quick-start-guide.rst b/docs/container-runtime/quick-start-guide.rst index c8d72e1..f66a1ee 100644 --- a/docs/container-runtime/quick-start-guide.rst +++ b/docs/container-runtime/quick-start-guide.rst @@ -115,7 +115,7 @@ Step 5: Configure Docker Runtime for AMD GPUs .. code-block:: bash - sudo amd-ctk configure runtime + sudo amd-ctk runtime configure sudo systemctl restart docker This configuration ensures that Docker is aware of the AMD container runtime and is able to support GPU-accelerated workloads using AMD Instinct devices. diff --git a/docs/container-runtime/release-notes.rst b/docs/container-runtime/release-notes.rst index 2c73e8d..2bcff30 100644 --- a/docs/container-runtime/release-notes.rst +++ b/docs/container-runtime/release-notes.rst @@ -11,7 +11,6 @@ Versioning Information Current Version: **1.0.0** -- ROCm Compatibility: **6.3.x** - Docker Compatibility: **25.0+** - Supported Distributions: Ubuntu 22.04, Ubuntu 24.04 @@ -62,10 +61,8 @@ Compatibility Matrix :header-rows: 1 * - AMD Container Toolkit - - ROCm Version - Docker Version * - 1.0.0 - - 6.3.x - 25.0+ Next Steps diff --git a/docs/container-runtime/requirements.rst b/docs/container-runtime/requirements.rst index c3b60c6..4deeea6 100644 --- a/docs/container-runtime/requirements.rst +++ b/docs/container-runtime/requirements.rst @@ -8,27 +8,18 @@ Operating Systems - Ubuntu 22.04 LTS (Jammy Jellyfish) - Ubuntu 24.04 LTS (Noble Numbat) -Software Requirements: ------------------------ -- ROCm Software Stack: Version 6.3.x -- AMDGPU Driver: Version 6.10.5 (or corresponding to ROCm 6.3.x) -- Toolkit packages are tested with specific ROCm and AMDGPU driver versions. - -Hardware Requirements: ------------------------ -- An AMD GPU supported by the ROCm 6.3.x release. -- CPU with virtualization support (if containers require nested environments). - Compatibility Matrix -------------------- - Each AMD Container Toolkit release is tightly coupled with a specific ROCm and AMDGPU driver version. Please refer to the compatibility matrix before proceeding. - -+--------------------------------------+---------------+-----------------------+ -| Container Toolkit Debian Version | ROCm Version | AMDGPU Driver Version | -+--------------------------------------+---------------+-----------------------+ -| amd-container-toolkit-1.0.0 | ROCm 6.3.x | 6.10.5 | -+--------------------------------------+---------------+-----------------------+ +.. list-table:: Compatibility Matrix + :header-rows: 1 + :widths: 30 20 25 + + * - Container Toolkit Debian Version + - Docker Version + * - amd-container-toolkit-1.0.0 + - 25 Note ---- From 58cc5da3cc33bbec787e0d56bb7f7e1239475f99 Mon Sep 17 00:00:00 2001 From: im-AbhiP Date: Tue, 3 Jun 2025 11:34:49 -0700 Subject: [PATCH 2/3] Modified the index page to remove redundancy. --- docs/container-runtime/index.rst | 14 --------- docs/container-runtime/requirements.rst | 6 ++-- docs/index.md | 10 ++++++ docs/sphinx/_toc.yml.in | 42 +++++++++++-------------- 4 files changed, 32 insertions(+), 40 deletions(-) delete mode 100644 docs/container-runtime/index.rst diff --git a/docs/container-runtime/index.rst b/docs/container-runtime/index.rst deleted file mode 100644 index c8c5dcf..0000000 --- a/docs/container-runtime/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -AMD Container Toolkit Documentation -==================================== - -Welcome to the official documentation for the AMD Container Toolkit! - -- :doc:`overview` -- :doc:`requirements` -- :doc:`quick-start-guide` -- :doc:`framework-integration` -- :doc:`troubleshooting` -- :doc:`migration-guide` -- :doc:`developer-guide` -- :doc:`docker-compose` -- :doc:`release-notes` diff --git a/docs/container-runtime/requirements.rst b/docs/container-runtime/requirements.rst index 4deeea6..57f19ef 100644 --- a/docs/container-runtime/requirements.rst +++ b/docs/container-runtime/requirements.rst @@ -10,16 +10,16 @@ Operating Systems Compatibility Matrix -------------------- - - Each AMD Container Toolkit release is tightly coupled with a specific ROCm and AMDGPU driver version. Please refer to the compatibility matrix before proceeding. + .. list-table:: Compatibility Matrix :header-rows: 1 - :widths: 30 20 25 + :widths: 30 20 * - Container Toolkit Debian Version - Docker Version * - amd-container-toolkit-1.0.0 - - 25 + - 25+ Note ---- diff --git a/docs/index.md b/docs/index.md index 09590fc..862a75e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,3 +8,13 @@ myst: # AMD Container Toolkit Documentation This documentation site provides information about the AMD Container Toolkit, which is a set of tools and libraries for running GPU-accelerated applications in containers. The ROCm platform is designed to enable high-performance computing (HPC) and machine learning workloads on AMD GPUs. + +- [Overview](container-runtime/overview.rst) +- [Requirements](container-runtime/requirements.rst) +- [Quick Start Guide](container-runtime/quick-start-guide.rst) +- [Framework Integration](container-runtime/framework-integration.rst) +- [Troubleshooting](container-runtime/troubleshooting.rst) +- [Migration Guide](container-runtime/migration-guide.rst) +- [Developer Guide](container-runtime/developer-guide.rst) +- [Docker Compose](container-runtime/docker-compose.rst) +- [Release Notes](container-runtime/release-notes.rst) diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 1a1bc65..19e7d17 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -1,26 +1,22 @@ root: index.md subtrees: - - caption: Tools + - caption: AMD Container Toolkit entries: - - file: container-runtime/index.rst - title: AMD Container Toolkit - subtrees: - - entries: - - file: container-runtime/overview.rst - title: Overview - - file: container-runtime/requirements.rst - title: Requirements - - file: container-runtime/quick-start-guide.rst - title: Quick Start Guide - - file: container-runtime/framework-integration.rst - title: Framework Integration - - file: container-runtime/troubleshooting - title: Troubleshooting - - file: container-runtime/migration-guide.rst - title: Migration Guide - - file: container-runtime/developer-guide.rst - title: Developer Guide - - file: container-runtime/docker-compose.rst - title: Docker Compose Usage - - file: container-runtime/release-notes.rst - title: Release Notes + - file: container-runtime/overview.rst + title: Overview + - file: container-runtime/requirements.rst + title: Requirements + - file: container-runtime/quick-start-guide.rst + title: Quick Start Guide + - file: container-runtime/framework-integration.rst + title: Framework Integration + - file: container-runtime/troubleshooting.rst + title: Troubleshooting + - file: container-runtime/migration-guide.rst + title: Migration Guide + - file: container-runtime/developer-guide.rst + title: Developer Guide + - file: container-runtime/docker-compose.rst + title: Docker Compose Usage + - file: container-runtime/release-notes.rst + title: Release Notes From 447c3b632350f5713697ca26661c7e75fb46948f Mon Sep 17 00:00:00 2001 From: im-AbhiP Date: Tue, 3 Jun 2025 11:46:04 -0700 Subject: [PATCH 3/3] Removed reference to rocm version dependency. --- docs/container-runtime/requirements.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/container-runtime/requirements.rst b/docs/container-runtime/requirements.rst index 57f19ef..7e731d1 100644 --- a/docs/container-runtime/requirements.rst +++ b/docs/container-runtime/requirements.rst @@ -10,7 +10,7 @@ Operating Systems Compatibility Matrix -------------------- -- Each AMD Container Toolkit release is tightly coupled with a specific ROCm and AMDGPU driver version. Please refer to the compatibility matrix before proceeding. +- Please refer to the compatibility matrix before proceeding. .. list-table:: Compatibility Matrix :header-rows: 1