Add Build-ROCm page (#109)

* add build-rocm page

* change tools name to Optimization with new card image, and reordered tool groups

* Update docs/how-to/build-rocm.rst with writer edits

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>

* fix link to build page on index

* restore the performance banner

---------

Co-authored-by: Leo Paoletti <164940351+lpaoletti@users.noreply.github.com>
This commit is contained in:
Young Hui - AMD
2024-07-25 11:16:12 -04:00
committed by GitHub
parent 7dcf79f95e
commit 2c5aabec54
5 changed files with 55 additions and 29 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

View File

@@ -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 `<https://github.com/ROCm/ROCm>`__.
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 <https://github.com/ROCm/ROCm?tab=readme-ov-file#build-rocm-from-source>`_

View File

@@ -18,6 +18,7 @@ Installation instructions are available from:
* {doc}`ROCm installation for Linux<rocm-install-on-linux:index>`
* {doc}`HIP SDK installation for Windows<rocm-install-on-windows:index>`
* [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:

View File

@@ -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 <hipify:index>`
* {doc}`ROCm Debugger (ROCgdb) <rocgdb:index>`
* {doc}`ROCdbgapi <rocdbgapi:index>`
* {doc}`ROCr Debug Agent <rocr_debug_agent:index>`
:::
(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 <rocm_bandwidth_test:index>`
* {doc}`ROCProfiler <rocprofiler:profiler_home_page>`
* [rocprofiler-register](https://github.com/ROCm/rocprofiler-register)
* {doc}`ROCTracer <roctracer:index>`
:::
(system-tools)=
:::{grid-item-card}
@@ -55,4 +26,33 @@
* {doc}`ROCm Validation Suite <rocmvalidationsuite:index>`
:::
(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 <rocm_bandwidth_test:index>`
* {doc}`ROCProfiler <rocprofiler:profiler_home_page>`
* [rocprofiler-register](https://github.com/ROCm/rocprofiler-register)
* {doc}`ROCTracer <roctracer:index>`
:::
(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 <hipify:index>`
* {doc}`ROCm Debugger (ROCgdb) <rocgdb:index>`
* {doc}`ROCdbgapi <rocdbgapi:index>`
* {doc}`ROCr Debug Agent <rocr_debug_agent:index>`
:::
::::

View File

@@ -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: