diff --git a/docs/data/unused-images/banner-optimization.jpg b/docs/data/unused-images/banner-optimization.jpg new file mode 100644 index 000000000..cd4a2f15d Binary files /dev/null and b/docs/data/unused-images/banner-optimization.jpg differ diff --git a/docs/how-to/build-rocm.rst b/docs/how-to/build-rocm.rst new file mode 100644 index 000000000..42b06f79b --- /dev/null +++ b/docs/how-to/build-rocm.rst @@ -0,0 +1,23 @@ +.. meta:: + :description: Build ROCm from source + :keywords: build ROCm, source, ROCm source, ROCm, repo, make, makefile + + +.. _building-rocm: + +************************************************************* +Build ROCm from source +************************************************************* + +ROCm is an open-source stack from which you can build from source code. The source code is available from ``__. + + +The general steps to build ROCm are: + +#. Clone the ROCm source code +#. Prepare the build environment +#. Run the build command + +Because the ROCm stack is constantly evolving, the most current instructions are stored with the source code in GitHub. +For detailed build instructions, see `Build ROCm from source `_ + diff --git a/docs/index.md b/docs/index.md index d51dec2df..36a051d11 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,6 +18,7 @@ Installation instructions are available from: * {doc}`ROCm installation for Linux` * {doc}`HIP SDK installation for Windows` * [Deep learning frameworks installation](./how-to/deep-learning-rocm.rst) +* [Build ROCm from source](./how-to/build-rocm.rst) ROCm documentation is organized into the following categories: diff --git a/docs/reference/rocm-tools.md b/docs/reference/rocm-tools.md index fbec6eddd..c874676ac 100644 --- a/docs/reference/rocm-tools.md +++ b/docs/reference/rocm-tools.md @@ -11,35 +11,6 @@ ::::{grid} 1 2 2 2 :class-container: rocm-doc-grid -(development-tools)= - -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-development.jpg -:img-alt: Development tools -:padding: 2 - -* [ROCm Compilers](https://rocm.docs.amd.com/projects/llvm-project/en/latest/reference/rocmcc.html) -* {doc}`HIPIFY ` -* {doc}`ROCm Debugger (ROCgdb) ` -* {doc}`ROCdbgapi ` -* {doc}`ROCr Debug Agent ` -::: - -(performance-tools)= - -:::{grid-item-card} -:class-card: sd-text-black -:img-top: ../data/reference/banner-performance.jpg -:img-alt: Performance tools -:padding: 2 - -* {doc}`ROCm Bandwidth Test ` -* {doc}`ROCProfiler ` -* [rocprofiler-register](https://github.com/ROCm/rocprofiler-register) -* {doc}`ROCTracer ` -::: - (system-tools)= :::{grid-item-card} @@ -55,4 +26,33 @@ * {doc}`ROCm Validation Suite ` ::: +(performance-tools)= + +:::{grid-item-card} +:class-card: sd-text-black +:img-top: ../data/reference/banner-performance.jpg +:img-alt: Performance tools +:padding: 2 + +* {doc}`ROCm Bandwidth Test ` +* {doc}`ROCProfiler ` +* [rocprofiler-register](https://github.com/ROCm/rocprofiler-register) +* {doc}`ROCTracer ` +::: + +(development-tools)= + +:::{grid-item-card} +:class-card: sd-text-black +:img-top: ../data/reference/banner-development.jpg +:img-alt: Development tools +:padding: 2 + +* [ROCm Compilers](https://rocm.docs.amd.com/projects/llvm-project/en/latest/reference/rocmcc.html) +* {doc}`HIPIFY ` +* {doc}`ROCm Debugger (ROCgdb) ` +* {doc}`ROCdbgapi ` +* {doc}`ROCr Debug Agent ` +::: + :::: diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in index 68456488e..e8ba06271 100644 --- a/docs/sphinx/_toc.yml.in +++ b/docs/sphinx/_toc.yml.in @@ -24,6 +24,8 @@ subtrees: title: HIP SDK on Windows - file: how-to/deep-learning-rocm.md title: Deep learning frameworks + - file: how-to/build-rocm.rst + title: Build ROCm from source - caption: How to entries: