github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-04-27 03:01:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

new banner images (#2884)

Browse Source
This commit is contained in:
Lisa
2024-02-08 11:53:48 -07:00
committed by GitHub
parent 8bbd51376d
commit 3c94962813
20 changed files with 140 additions and 181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/contribute/contributing.md
View File

@@ -8,23 +8,18 @@
All ROCm projects are GitHub-based, so if you want to contribute, you can do so by:
* [Submitting a pull request (PR) in the appropriate GitHub repository](#submit-a-pull-request)
* [Submitting a pull request in the appropriate GitHub repository](#submit-a-pull-request)
* [Creating an issue in the appropriate GitHub repository](#create-an-issue)
* [Suggesting a new feature](#suggest-a-new-feature)
```{note}
Because some of our components are inherited from external projects (such as
[LLVM](https://github.com/ROCm/llvm-project) and
[Kernel driver](https://github.com/ROCm/ROCK-Kernel-Driver)), they use project-specific
contribution guidelines and workflow.
```{important}
By creating a pull request (PR), you agree to allow your contribution to be licensed under the terms of the
LICENSE.txt file in the corresponding repository. Different repositories may use different licenses.
```
## Submit a pull request
```{important}
By creating a PR, you agree to allow your contribution to be licensed under the terms of the
LICENSE.txt file in the corresponding repository. Different repositories may use different licenses.
```
To make edits to our documentation via PR, follow these steps:
1. Identify the repository and the file you want to update. For example, to update this page, you would
need to modify content located in this file:

BIN
docs/data/banner-text.xcf
View File

Binary file not shown.

BIN
docs/data/reference/banner-ai.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 208 KiB

BIN
docs/data/reference/banner-communication.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 207 KiB

BIN
docs/data/reference/banner-cpp-primitives.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 205 KiB

BIN
docs/data/reference/banner-development.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 204 KiB

BIN
docs/data/reference/banner-hip.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 204 KiB

BIN
docs/data/reference/banner-math.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 206 KiB

BIN
docs/data/reference/banner-performance.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 208 KiB

BIN
docs/data/reference/banner-random-number.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 206 KiB

BIN
docs/data/reference/banner-system.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 204 KiB

2
docs/how-to/tuning-guides/mi100.md
View File

@@ -368,7 +368,7 @@ For a complete guide on how to install/manage/uninstall ROCm on Linux, refer to
{doc}`Quick-start (Linux)<rocm-install-on-linux:tutorial/quick-start>`. To verify that the installation was
successful, refer to the
{doc}`post-install instructions<rocm-install-on-linux:how-to/native-install/post-install>` and
[Validation Tools](../../reference/library-index.md). Should verification
[system tools](../../reference/rocm-tools.md). Should verification
fail, consult the [System Debugging Guide](../system-debugging.md).
(mi100-hw-verification)=

2
docs/how-to/tuning-guides/mi200.md
View File

@@ -353,7 +353,7 @@ For a complete guide on how to install/manage/uninstall ROCm on Linux, refer to
{doc}`Quick-start (Linux)<rocm-install-on-linux:tutorial/quick-start>`. For verifying that the
installation was successful, refer to the
{doc}`post-install instructions<rocm-install-on-linux:how-to/native-install/post-install>` and
[Validation Tools](../../reference/library-index.md). Should verification
[system tools](../../reference/rocm-tools.md). Should verification
fail, consult the [System Debugging Guide](../system-debugging.md).
(mi200-hw-verification)=

33
docs/index.md
View File

@@ -50,26 +50,25 @@ Our documentation is organized into the following categories:
* {doc}`User/kernel space<rocm-install-on-linux:reference/user-kernel-space-compat-matrix>`
* {doc}`Docker<rocm-install-on-linux:reference/docker-image-support-matrix>`
* [OpenMP](./about/compatibility/openmp.md)
{doc}`ROCm on Radeon GPUs<radeon:index>`
* {doc}`ROCm on Radeon GPUs<radeon:index>`
:::
:::{grid-item-card}
:padding: 2
:img-top: ./data/banner-reference.png
* [API Libraries & tools](./reference/library-index.md)
* Libraries:
* Artificial intelligence
* C++ primitives
* Communication
* Fast Fourier transforms
* HIP
* Linear algebra
* Random number generators
* Tools for:
* Development
* Performance analysis
* System
* [API libraries](./reference/api-libraries.md)
* Artificial intelligence
* C++ primitives
* Communication
* Fast Fourier transforms
* HIP
* Linear algebra
* Random number generators
* [Tools](./reference/rocm-tools.md)
* Development
* Performance analysis
* System
:::
:::{grid-item-card}
@@ -107,9 +106,3 @@ Our documentation is organized into the following categories:
:::
::::
We welcome collaboration! If you'd like to contribute to our documentation, you can find instructions
on our [Contribute to ROCm docs](./contribute/contributing.md) page. Known issues are listed on
[GitHub](https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue).
Licensing information for all ROCm components is listed on our [Licensing](./about/license.md) page.

71
docs/reference/api-libraries.md Normal file
View File

@@ -0,0 +1,71 @@
<head>
<meta charset="UTF-8">
<meta name="description" content="ROCm API libraries & tools">
<meta name="keywords" content="ROCm, API, libraries, tools, artificial intelligence, development,
Communications, C++ primitives, Fast Fourier transforms, FFTs, random number generators, linear
algebra, AMD">
</head>
# ROCm API libraries
::::{grid} 1 2 2 2
:class-container: rocm-doc-grid
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-ai.png
* {doc}`Composable Kernel <composable_kernel:index>`
* {doc}`MIGraphX <amdmigraphx:index>`
* {doc}`MIOpen <miopen:index>`
* {doc}`MIVisionX <mivisionx:doxygen/html/index>`
:::
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-cpp-primitives.png
* {doc}`hipCUB <hipcub:index>`
* {doc}`hipTensor <hiptensor:index>`
* {doc}`rocPRIM <rocprim:index>`
* {doc}`rocThrust <rocthrust:index>`
:::
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-communication.png
* {doc}`RCCL <rccl:index>`
:::
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-hip.png
* {doc}`HIP runtime <hip:index>`
* {doc}`HIPIFY <hipify:index>`
:::
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-math.png
* {doc}`hipBLAS <hipblas:index>` / {doc}`rocBLAS <rocblas:index>`
* {doc}`hipBLASLt <hipblaslt:index>`
* {doc}`hipFFT <hipfft:index>` / {doc}`rocFFT <rocfft:index>`
* {doc}`hipSOLVER <hipsolver:index>` / {doc}`rocSOLVER <rocsolver:index>`
* {doc}`hipSPARSE <hipsparse:index>` / {doc}`rocSPARSE <rocsparse:index>`
* {doc}`hipSPARSELt <hipsparselt:index>`
* {doc}`rocALUTION <rocalution:index>`
* {doc}`rocWMMA <rocwmma:index>`
:::
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-random-number.png
* {doc}`hipRAND <hiprand:index>`
* {doc}`rocRAND <rocrand:index>`
:::
::::

145
docs/reference/library-index.md
View File

@@ -1,145 +0,0 @@
<head>
<meta charset="UTF-8">
<meta name="description" content="ROCm API libraries & tools">
<meta name="keywords" content="ROCm, API, libraries, tools, artificial intelligence, development,
Communications, C++ primitives, Fast Fourier transforms, FFTs, random number generators, linear
algebra, AMD">
</head>
# ROCm API libraries & tools
::::{grid} 1 3 3 3
:class-container: rocm-doc-grid
:::{grid-item-card}
:padding: 2
**Artificial intelligence**
^^^
* {doc}`Composable Kernel <composable_kernel:index>`
* {doc}`MIGraphX <amdmigraphx:index>`
* {doc}`MIOpen <miopen:index>`
* {doc}`MIVisionX <mivisionx:doxygen/html/index>`
:::
:::{grid-item-card}
:padding: 2
**C++ primitives**
^^^
* {doc}`hipCUB <hipcub:index>`
* {doc}`hipTensor <hiptensor:index>`
* {doc}`rocPRIM <rocprim:index>`
* {doc}`rocThrust <rocthrust:index>`
:::
:::{grid-item-card}
:padding: 2
**Communication**
^^^
* {doc}`RCCL <rccl:index>`
:::
:::{grid-item-card}
:padding: 2
**Development tools**
^^^
* {doc}`ROCdbgapi <rocdbgapi:index>`
* [ROCmCC](./rocmcc.md)
* {doc}`ROCm debugger (ROCgdb) <rocgdb:index>`
* {doc}`ROCTracer <roctracer:index>`
:::
:::{grid-item-card}
:padding: 2
**Fast Fourier transforms (FFTs)**
^^^
* {doc}`hipFFT <hipfft:index>`
* {doc}`rocFFT <rocfft:index>`
:::
:::{grid-item-card}
:padding: 2
**HIP**
^^^
* {doc}`HIP runtime <hip:index>`
* {doc}`HIPIFY <hipify:index>`
:::
:::{grid-item-card}
:padding: 2
**Linear algebra**
^^^
* {doc}`hipBLAS <hipblas:index>`
* {doc}`hipBLASLt <hipblaslt:index>`
* {doc}`hipSOLVER <hipsolver:index>`
* {doc}`hipSPARSE <hipsparse:index>`
* {doc}`hipSPARSELt <hipsparselt:index>`
* {doc}`rocALUTION <rocalution:index>`
* {doc}`rocBLAS <rocblas:index>`
* {doc}`rocSOLVER <rocsolver:index>`
* {doc}`rocSPARSE <rocsparse:index>`
* {doc}`rocWMMA <rocwmma:index>`
:::
:::{grid-item-card}
:padding: 2
**Performance analysis**
^^^
* {doc}`ROCProfiler <rocprofiler:profiler_home_page>`
* {doc}`ROCTracer <roctracer:index>`
:::
:::{grid-item-card}
:padding: 2
**Random number generators**
^^^
* {doc}`hipRAND <hiprand:index>`
* {doc}`rocRAND <rocrand:index>`
:::
:::{grid-item-card}
:padding: 2
**System tools**
^^^
* {doc}`AMD SMI <amdsmi:index>`
* {doc}`ROCm Data Center Tool <rdc:index>`
* {doc}`ROCm SMI <rocm_smi_lib:index>`
* {doc}`ROCm Validation Suite <rocmvalidationsuite:index>`
* {doc}`TransferBench <transferbench:index>`
:::
::::
We welcome collaboration! If you'd like to contribute to our documentation, you can find instructions
on our [Contribute to ROCm docs](../contribute/contributing.md) page. Known issues are listed on
[GitHub](https://github.com/RadeonOpenCompute/ROCm/labels/Verified%20Issue).
Licensing information for all ROCm components is listed on our [Licensing](../about/license.md) page.

43
docs/reference/rocm-tools.md Normal file
View File

@@ -0,0 +1,43 @@
<head>
<meta charset="UTF-8">
<meta name="description" content="ROCm API libraries & tools">
<meta name="keywords" content="ROCm, API, libraries, tools, artificial intelligence, development,
Communications, C++ primitives, Fast Fourier transforms, FFTs, random number generators, linear
algebra, AMD">
</head>
# ROCm tools
::::{grid} 1 2 2 2
:class-container: rocm-doc-grid
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-development.png
* {doc}`ROCdbgapi <rocdbgapi:index>`
* [ROCmCC](./rocmcc.md)
* {doc}`ROCm debugger (ROCgdb) <rocgdb:index>`
* {doc}`ROCTracer <roctracer:index>`
:::
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-performance.png
* {doc}`ROCProfiler <rocprofiler:profiler_home_page>`
* {doc}`ROCTracer <roctracer:index>`
:::
:::{grid-item-card}
:padding: 2
:img-top: ../data/reference/banner-system.png
* {doc}`AMD SMI <amdsmi:index>`
* {doc}`ROCm Data Center Tool <rdc:index>`
* {doc}`ROCm SMI <rocm_smi_lib:index>`
* {doc}`ROCm Validation Suite <rocmvalidationsuite:index>`
* {doc}`TransferBench <transferbench:index>`
:::
::::

6
docs/sphinx/_toc.yml.in
View File

@@ -32,8 +32,10 @@ subtrees:
- caption: Reference
entries:
- file: reference/library-index.md
title: API libraries & tools
- file: reference/api-libraries.md
title: API libraries
- file: reference/rocm-tools.md
title: Tools
- caption: How-to
entries: