Doc update (#2011)

* add url to ROCgdb-docs

update reqs and gitignore

* add validation tools section for RVS and TransferBench

* stub in links for validation/mgmt tools

* populate compilers page

* add cards for ai libs and computer vision pages

* add content to math lib pages

* reorg hip and math libs

* update index

* consolidate linear algebra libs

* fix release info order in toc

* fix links and content cards for libraries

* update mdl ignored files

* update understand rocm section

* fix formatting errors

* add link to openmp

* ignore md041
This commit is contained in:
Sam Wu
2023-03-31 18:04:21 -06:00
committed by GitHub
parent e83512605d
commit 9833748ff0
23 changed files with 121 additions and 91 deletions

View File

@@ -3,24 +3,24 @@
::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} MIOpen
:::{grid-item-card} [MIOpen](https://rocmdocs.amd.com/projects/MIOpen/en/latest/)
AMD's library for high performance machine learning primitives.
- [API Reference Manual](https://rocmdocs.amd.com/projects/MIOpen/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/MIOpen/en/latest/)
:::
:::{grid-item-card} Composable Kernel
:::{grid-item-card} [Composable Kernel](https://rocmdocs.amd.com/projects/composable_kernel/en/latest/)
Composable Kernel: Performance Portable Programming Model for Machine Learning Tensor Operators
- [API Reference Manual](https://rocmdocs.amd.com/projects/composable_kernel/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/composable_kernel/en/latest/)
:::
:::{grid-item-card} MIGraphX
:::{grid-item-card} [MIGraphX](https://rocmdocs.amd.com/projects/MIGraphX/en/latest/)
AMD MIGraphX is AMD's graph inference engine that accelerates machine learning model inference.
- [API Reference Manual](https://rocmdocs.amd.com/projects/MIGraphX/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/MIGraphX/en/latest/)
:::

View File

@@ -4,8 +4,8 @@
:::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} HIP Runtime
The HIP Runtime is used to enable GPU acceleration for all HIP language based products.
:::{grid-item-card} [HIP](./hip)
HIP is both AMD's GPU programming language extension and the GPU runtime.
- [HIP Runtime API Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/rtd/)
- [Examples](https://github.com/amd/rocm-examples/tree/develop/HIP-Basic)
@@ -15,15 +15,13 @@ The HIP Runtime is used to enable GPU acceleration for all HIP language based pr
:::{grid-item-card} [Math Libraries](./gpu_libraries/math)
HIP Math Libraries support the following domains:
- [Matrix Multiplication](./gpu_libraries/blas)
- [Linear Algebra Libraries](./gpu_libraries/linear_algebra)
- [Fast Fourier Transforms](./gpu_libraries/fft)
- [Random Numbers](./gpu_libraries/rand)
- [Linear Solvers](./gpu_libraries/solver)
- [Sparse Matrix Solvers](./gpu_libraries/sparse)
:::
:::{grid-item-card} [C++ Primitives](./gpu_libraries/c++_primitives)
:::{grid-item-card} [C++ Primitive Libraries](./gpu_libraries/c++_primitives)
ROCm template libraries for C++ primitives and algorithms are as follows:
- [rocPRIM](https://rocprim.readthedocs.io/en/latest/)
@@ -37,23 +35,14 @@ Inter and intra node communication is supported by the following projects:
- [RCCL](https://rocmdocs.amd.com/projects/rccl/en/latest/)
:::
:::{grid-item-card} MIOpen
AMD's library for high performance machine learning primitives.
:::{grid-item-card} [AI Libraries](./ai_tools)
Libraries related to AI.
- [API Reference Manual](https://rocmdocs.amd.com/projects/MIOpen/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/MIOpen/blob/develop/CHANGELOG.md)
:::
:::{grid-item-card} MIGraphX
AMD's graph optimization engine.
- [API Reference Manual](https://rocmdocs.amd.com/projects/AMDMIGraphX/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/MIGraphX/blob/develop/CHANGELOG.md)
- [MIOpen](https://rocmdocs.amd.com/projects/MIOpen/en/latest/)
- [Composable Kernel](https://rocmdocs.amd.com/projects/composable_kernel/en/latest/)
- [MIGraphX](https://rocmdocs.amd.com/projects/MIGraphX/en/latest/)
:::
@@ -65,5 +54,41 @@ Computer vision related projects.
:::
:::{grid-item-card} [OpenMP](openmp/openmp)
:::::
- [OpenMP Support Guide](openmp/openmp)
:::
:::{grid-item-card} [Compilers and Tools](compilers)
- [ROCmCC](https://rocmdocs.amd.com/projects/ROCmCC/en/latest/)
- [ROCgdb](https://rocmdocs.amd.com/projects/ROCgdb/en/latest/)
- [ROCProfiler](https://rocmdocs.amd.com/projects/rocprofiler/en/latest/)
- [ROCTracer](https://rocmdocs.amd.com/projects/roctracer/en/latest/)
:::
:::{grid-item-card} [Management Tools](management_tools)
- [AMD SMI](https://rocmdocs.amd.com/projects/amdsmi/en/latest/)
- [ROCm SMI](https://rocmdocs.amd.com/projects/rocmsmi/en/latest/)
- [ROCm Datacenter Tool](https://rocmdocs.amd.com/projects/rdc/en/latest/)
:::
:::{grid-item-card} [Validation Tools](validation_tools)
- [ROCm Validation Suite](https://rocmdocs.amd.com/projects/RVS/en/latest/)
- [TransferBench](https://rocmdocs.amd.com/projects/TransferBench/en/latest/)
:::
:::{grid-item-card} [GPU Architectures](gpu_arch)
- [AMD Instinct MI200](./gpu_arch/mi250.md)
- [AMD Instinct MI100](./gpu_arch/mi100.md)
:::
:::::

View File

@@ -3,31 +3,31 @@
:::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} ROCmCC
:::{grid-item-card} [ROCmCC](https://rocmdocs.amd.com/projects/ROCmCC/en/latest/)
ROCmCC is a Clang/LLVM-based compiler. It is optimized for high-performance computing on AMD GPUs and CPUs and supports various heterogeneous programming models such as HIP, OpenMP, and OpenCL.
- [API Reference Manual](https://rocmdocs.amd.com/projects/ROCmCC/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/ROCmCC/en/latest/)
:::
:::{grid-item-card} ROCgdb
:::{grid-item-card} [ROCgdb](https://rocmdocs.amd.com/projects/ROCgdb/en/latest/)
This is ROCgdb, the ROCm source-level debugger for Linux, based on GDB, the GNU source-level debugger.
- [API Reference Manual](https://rocmdocs.amd.com/projects/ROCgdb/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/ROCgdb/en/latest/)
:::
:::{grid-item-card} rocprofiler
:::{grid-item-card} [ROCProfiler](https://rocmdocs.amd.com/projects/rocprofiler/en/latest/)
ROC profiler library. Profiling with perf-counters and derived metrics. Library supports GFX8/GFX9. HW specific low-level performance analysis interface for profiling of GPU compute applications. The profiling includes HW performance counters with complex performance metrics.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocprofiler/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/rocprofiler/en/latest/)
:::
:::{grid-item-card} roctracer
:::{grid-item-card} [ROCTracer](https://rocmdocs.amd.com/projects/roctracer/en/latest/)
Callback/Activity Library for Performance tracing AMD GPU's
- [API Reference Manual](https://rocmdocs.amd.com/projects/roctracer/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/roctracer/en/latest/)
:::

View File

@@ -3,17 +3,17 @@
::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} MIVisionX
:::{grid-item-card} [MIVisionX](https://rocmdocs.amd.com/projects/MIVisionX/en/latest/)
MIVisionX toolkit is a set of comprehensive computer vision and machine intelligence libraries, utilities, and applications bundled into a single toolkit. AMD MIVisionX also delivers a highly optimized open-source implementation of the Khronos OpenVX™ and OpenVX™ Extensions.
- [API Reference Manual](https://rocmdocs.amd.com/projects/MIVisionX/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/MIVisionX/en/latest/)
:::
:::{grid-item-card} rocAL
:::{grid-item-card} [rocAL](https://rocmdocs.amd.com/projects/rocAL/en/latest/)
The AMD ROCm Augmentation Library (rocAL) is designed to efficiently decode and process images and videos from a variety of storage formats and modify them through a processing graph programmable by the user. rocAL currently provides C API.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocAL/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/rocAL/en/latest/)
:::

View File

@@ -0,0 +1 @@
# Docker

View File

@@ -4,33 +4,33 @@ ROCm template libraries for algorithms are as follows:
:::::{grid} 1 1 3 3
:gutter: 1
:::{grid-item-card} rocPRIM
:::{grid-item-card} [rocPRIM](https://rocmdocs.amd.com/projects/rocPRIM/en/latest/)
rocPRIM is an AMD GPU optimized template library of algorithm primitives, like
transforms, reductions, scans, etc. It also serves as a common back-end for
similar libraries found inside ROCm.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocPRIM/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/rocPRIM/en/latest/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocPRIM/blob/develop/CHANGELOG.md)
- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocPRIM)
:::
:::{grid-item-card} rocThrust
:::{grid-item-card} [rocThrust](https://rocmdocs.amd.com/projects/rocThrust/en/latest/)
rocThrust is a template library of algorithm primitives with a Thrust-compatible
interface. Their CPU back-ends are identical, while the GPU back-end calls into
rocPRIM.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocThrust/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/rocThrust/en/latest/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocThrust/blob/develop/CHANGELOG.md)
- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocThrust)
:::
:::{grid-item-card} hipCUB
:::{grid-item-card} [hipCUB](https://rocmdocs.amd.com/projects/hipCUB/en/latest/)
hipCUB is a template library of algorithm primitives with a CUB-compatible
interface. It's back-end is rocPRIM.
- [API Reference Manual](https://rocmdocs.amd.com/projects/hipCUB/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/hipCUB/en/latest/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/hipCUB/blob/develop/CHANGELOG.md)
- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/hipCUB)

View File

@@ -3,13 +3,13 @@
:::::{grid} 1 1 1 1
:gutter: 1
:::{grid-item-card} RCCL
:::{grid-item-card} [RCCL](https://rocmdocs.amd.com/projects/rccl/en/latest/)
RCCL (pronounced "Rickle") is a stand-alone library of standard collective communication routines for GPUs,
implementing all-reduce, all-gather, reduce, broadcast, reduce-scatter, gather, scatter, and all-to-all.
The collective operations are implemented using ring and tree algorithms and have been optimized for
throughput and latency.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rccl/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/rccl/en/latest/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/CHANGELOG.md)
- [Examples](https://github.com/ROCmSoftwarePlatform/rccl/tree/develop/tools)

View File

@@ -5,21 +5,21 @@ ROCm libraries for FFT are as follows:
:::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} rocFFT
:::{grid-item-card} [rocFFT](https://rocmdocs.amd.com/projects/rocFFT/en/rtd/)
rocFFT is an AMD GPU optimized library for FFT.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocFFT/en/rtd/)
- [Documentation](https://rocmdocs.amd.com/projects/rocFFT/en/rtd/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/develop/CHANGELOG.md)
- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocFFT)
:::
:::{grid-item-card} hipFFT
hipFFT is a compatiblity layer for GPU accelerated FFT optimized for AMD GPUs
:::{grid-item-card} [hipFFT](https://rocmdocs.amd.com/projects/hipFFT/en/rtd/)
hipFFT is a compatibility layer for GPU accelerated FFT optimized for AMD GPUs
using rocFFT. hipFFT allows for a common interface for other non AMD GPU
FFT libraries.
- [API Reference Manual](https://rocmdocs.amd.com/projects/hipFFT/en/rtd/)
- [Documentation](https://rocmdocs.amd.com/projects/hipFFT/en/rtd/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/hipFFT/blob/develop/CHANGELOG.md)
:::

View File

@@ -5,37 +5,37 @@ ROCm libraries for linear algebra are as follows:
:::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} rocBLAS
:::{grid-item-card} [rocBLAS](https://rocmdocs.amd.com/projects/rocBLAS/en/develop/)
rocBLAS is an AMD GPU optimized library for BLAS.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocBLAS/en/develop/)
- [Documentation](https://rocmdocs.amd.com/projects/rocBLAS/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocBLAS/blob/develop/CHANGELOG.md)
- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocBLAS)
:::
:::{grid-item-card} hipBLAS
:::{grid-item-card} [hipBLAS](https://rocmdocs.amd.com/projects/hipBLAS/en/develop/)
hipBLAS is a compatiblity layer for GPU accelerated BLAS optimized for AMD GPUs
via rocBLAS and rocSOLVER. hipBLAS allows for a common interface for other GPU
BLAS libraries.
- [API Reference Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/develop/)
- [Documentation](https://rocmdocs.amd.com/projects/hipBLAS/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLAS/blob/develop/CHANGELOG.md)
:::
:::{grid-item-card} hipBLASLt
:::{grid-item-card} [hipBLASLt](https://rocmdocs.amd.com/projects/hipBLASLt/en/develop/)
hipBLASLt is a library that provides general matrix-matrix operations with a flexible API and extends funtionalities beyond traditional BLAS library. hipBLASLt is exposed APIs in HIP programming language with an underlying optimized generator as a backend kernel provider.
- [API Reference Manual](https://rocmdocs.amd.com/projects/hipBLASLt/en/develop/)
- [Documentation](https://rocmdocs.amd.com/projects/hipBLASLt/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/hipBLASLt/blob/develop/CHANGELOG.md)
:::
:::{grid-item-card} rocALUTION
:::{grid-item-card} [rocALUTION](https://rocmdocs.amd.com/projects/rocALUTION/en/develop/)
rocALUTION is a sparse linear algebra library with focus on exploring fine-grained parallelism on top of AMDs Radeon Open Compute ROCm runtime and toolchains, targeting modern CPU and GPU platforms.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocALUTION/en/develop/)
- [Documentation](https://rocmdocs.amd.com/projects/rocALUTION/en/develop/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocALUTION/blob/develop/CHANGELOG.md)
:::

View File

@@ -39,5 +39,3 @@ at compile-time of the hipLIB in question. For dynamic dispatch between vendor i
- [hipRAND](https://rocmdocs.amd.com/projects/hipRAND/en/develop/)
:::
:::::

View File

@@ -3,21 +3,21 @@
:::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} rocRAND
:::{grid-item-card} [rocRAND](https://rocmdocs.amd.com/projects/rocRAND/en/rtd/)
rocRAND is an AMD GPU optimized library for pseudo-random number generators (PRNG).
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocRAND/en/rtd/)
- [Documentation](https://rocmdocs.amd.com/projects/rocRAND/en/rtd/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/rocRAND/blob/develop/CHANGELOG.md)
- [Examples](https://github.com/amd/rocm-examples/tree/develop/Libraries/rocRAND)
:::
:::{grid-item-card} hipRAND
:::{grid-item-card} [hipRAND](https://rocmdocs.amd.com/projects/hipRAND/en/rtd/)
hipRAND is a compatiblity layer for GPU accelerated FFT optimized for AMD GPUs
using rocFFT. hipFFT allows for a common interface for other non AMD GPU
FFT libraries.
- [API Reference Manual](https://rocmdocs.amd.com/projects/hipRAND/en/rtd/)
- [Documentation](https://rocmdocs.amd.com/projects/hipRAND/en/rtd/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/hipRAND/blob/develop/CHANGELOG.md)
:::

View File

@@ -1,13 +1,13 @@
# HIP
HIP is both AMD's GPU programming langauge extension and the GPU runtime. This page introduces the HIP runtime and other HIP libraries and tools.
HIP is both AMD's GPU programming language extension and the GPU runtime. This page introduces the HIP runtime and other HIP libraries and tools.
## HIP Runtime
:::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} HIP Runtime
:::{grid-item-card} [HIP Runtime](https://rocmdocs.amd.com/projects/hipBLAS/en/rtd/)
The HIP Runtime is used to enable GPU acceleration for all HIP language based products.
- [HIP Runtime API Manual](https://rocmdocs.amd.com/projects/hipBLAS/en/rtd/)
@@ -22,7 +22,7 @@ The HIP Runtime is used to enable GPU acceleration for all HIP language based pr
:::::{grid} 1 1 1 1
:gutter: 1
:::{grid-item-card} HIPify
:::{grid-item-card} [HIPify](https://rocmdocs.amd.com/projects/rocBLAS/en/rtd/)
HIPify assists with porting applications from based on CUDA to the HIP Runtime. Supported
CUDA APIs are documented here as well.

View File

@@ -3,7 +3,7 @@
:::::{grid} 1 1 3 3
:gutter: 1
:::{grid-item-card} AMD SMI
:::{grid-item-card} [AMD SMI](https://rocmdocs.amd.com/projects/amdsmi/en/latest/)
GO AMD SMI provides GO binding for [E-SMI In-Band C library](https://github.com/amd/esmi_ib_library.git),
[ROCm SMI Library](https://github.com/RadeonOpenCompute/rocm_smi_lib.git), and any
GO language application that needs to link with these libraries and call the APIs
@@ -11,23 +11,23 @@ from the GO application. The GO binding are imported in the
[AMD SMI Exporter](https://github.com/amd/amd_smi_exporter.git) to export information
provided by the AMD E-SMI inband library and the ROCm SMI GPU library to the Prometheus server.
- [API Reference Manual](https://rocmdocs.amd.com/projects/amdsmi/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/amdsmi/en/latest/)
- [Examples](https://github.com/amd/go_amd_smi#example)
:::
:::{grid-item-card} ROCm SMI
:::{grid-item-card} [ROCm SMI](https://rocmdocs.amd.com/projects/rocmsmi/en/latest/)
This tool acts as a command line interface for manipulating and monitoring the amdgpu kernel, and is intended to replace and deprecate the existing rocm_smi.py CLI tool. It uses Ctypes to call the rocm_smi_lib API.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rocmsmi/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/rocmsmi/en/latest/)
- [Examples](https://github.com/RadeonOpenCompute/rocm_smi_lib/tree/master/python_smi_tools)
:::
:::{grid-item-card} ROCm Datacenter Tool
:::{grid-item-card} [ROCm Datacenter Tool](https://rocmdocs.amd.com/projects/rdc/en/latest/)
The ROCm™ Data Center Tool simplifies the administration and addresses key infrastructure challenges in AMD GPUs in cluster and datacenter environments.
- [API Reference Manual](https://rocmdocs.amd.com/projects/rdc/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/rdc/en/latest/)
- [Examples](https://github.com/RadeonOpenCompute/rdc/tree/master/example)
:::

View File

@@ -3,17 +3,17 @@
:::::{grid} 1 1 2 2
:gutter: 1
:::{grid-item-card} RVS
:::{grid-item-card} [RVS](https://rocmdocs.amd.com/projects/RVS/en/latest/)
The ROCm Validation Suite is a system administrators and cluster manager's tool for detecting and troubleshooting common problems affecting AMD GPU(s) running in a high-performance computing environment, enabled using the ROCm software stack on a compatible platform.
- [API Reference Manual](https://rocmdocs.amd.com/projects/RVS/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/RVS/en/latest/)
:::
:::{grid-item-card} TransferBench
:::{grid-item-card} [TransferBench](https://rocmdocs.amd.com/projects/TransferBench/en/latest/)
TransferBench is a simple utility capable of benchmarking simultaneous transfers between user-specified devices (CPUs/GPUs).
- [API Reference Manual](https://rocmdocs.amd.com/projects/TransferBench/en/latest/)
- [Documentation](https://rocmdocs.amd.com/projects/TransferBench/en/latest/)
- [Changelog](https://github.com/ROCmSoftwarePlatform/TransferBench/blob/develop/CHANGELOG.md)
- [Examples](https://rocmdocs.amd.com/projects/TransferBench/en/develop/examples/index.html#examples)