From 4a5a411a7b5e7a519555abc7d3360f7f26bbf6f5 Mon Sep 17 00:00:00 2001 From: Peter Park Date: Fri, 14 Jun 2024 14:52:49 -0700 Subject: [PATCH 1/2] Update link to ROCr Debug Agent to docs portal (#3303) * Fix link to debug agent in what-is-rocm * ROCm --> ROCR add index * ROCR --> ROCr * Change ROCm Debug Agent to ROCr Debug Agent in docs --- docs/compatibility/compatibility-matrix.rst | 2 +- .../profiling-and-debugging.rst | 8 ++++---- docs/reference/rocm-tools.md | 4 ++-- docs/what-is-rocm.rst | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/compatibility/compatibility-matrix.rst b/docs/compatibility/compatibility-matrix.rst index 873925a93..42fcfb83f 100644 --- a/docs/compatibility/compatibility-matrix.rst +++ b/docs/compatibility/compatibility-matrix.rst @@ -94,7 +94,6 @@ Use this matrix to view the ROCm compatibility across successive major and minor :doc:`AMD SMI `,24.4.1,23.4.2 :doc:`HIPIFY `,17.0.0,17.0.0 :doc:`ROCdbgapi `,0.71.0,0.71.0 - `ROCm Debug Agent (ROCdebug-agent) `_,2.0.3,2.0.3 :doc:`rocminfo `,1.0.0,1.0.0 :doc:`ROCProfiler `,2.0.60100,2.0.0 `rocprofiler-register `_,0.3.0,N/A @@ -104,6 +103,7 @@ Use this matrix to view the ROCm compatibility across successive major and minor :doc:`ROCm Debugger (ROCgdb) `,14.1.0,13.2.0 :doc:`ROCm SMI `,7.0.0,6.0.0 :doc:`ROCm Validation Suite `,rocm-6.1.0,rocm-6.0.0 + :doc:`ROCr Debug Agent `,2.0.3,2.0.3 :doc:`TransferBench `,1.48,1.46 ,, COMPILERS:,, diff --git a/docs/how-to/llm-fine-tuning-optimization/profiling-and-debugging.rst b/docs/how-to/llm-fine-tuning-optimization/profiling-and-debugging.rst index 034b5021c..5a53a328e 100644 --- a/docs/how-to/llm-fine-tuning-optimization/profiling-and-debugging.rst +++ b/docs/how-to/llm-fine-tuning-optimization/profiling-and-debugging.rst @@ -138,10 +138,10 @@ For details usage and examples of using these tools, refer to the `Introduction to profiling tools for AMD hardware `_ developer blog. -Debugging with ROCm Debug Agent +Debugging with ROCr Debug Agent =============================== -ROCm Debug Agent (:doc:`ROCdebug-agent `) is a library that can be loaded by the ROCm platform +:doc:`ROCr Debug Agent `) is a library that can be loaded by the ROCm platform runtime (:doc:`ROCr `) to provide the following functionalities for all AMD accelerators and GPUs supported by the ROCm Debugger API (:doc:`ROCdbgapi `). @@ -155,9 +155,9 @@ Debugging memory access faults ------------------------------ Identifying a faulting kernel is often enough to triage a memory access fault. To that end, the -`ROCm Debug Agent `_ can trap a memory access fault and provide a dump of all +`ROCr Debug Agent `_ can trap a memory access fault and provide a dump of all active wavefronts that caused the error as well as the name of the kernel. The -`AMD ROCm Debug Agent Library README `_ provides full +`ROCr Debug Agent Library README `_ provides full instructions, but in brief: * Compiling with ``-ggdb -O0`` is recommended but not required. diff --git a/docs/reference/rocm-tools.md b/docs/reference/rocm-tools.md index 2e76b9ce6..9cc080b62 100644 --- a/docs/reference/rocm-tools.md +++ b/docs/reference/rocm-tools.md @@ -22,8 +22,8 @@ * {doc}`HIPIFY ` * {doc}`ROCdbgapi ` * [ROCmCC](./rocmcc.md) -* [ROCm Debug Agent](https://github.com/ROCm/rocr_debug_agent) -* {doc}`ROCm debugger (ROCgdb) ` +* {doc}`ROCm Debugger (ROCgdb) ` +* {doc}`ROCr Debug Agent ` ::: (performance-tools)= diff --git a/docs/what-is-rocm.rst b/docs/what-is-rocm.rst index 5272001cc..916ddf4e1 100644 --- a/docs/what-is-rocm.rst +++ b/docs/what-is-rocm.rst @@ -107,10 +107,10 @@ Tools ":doc:`ROCm Bandwidth Test `", "Captures the performance characteristics of buffer copying and kernel read/write operations" ":doc:`ROCm CMake `", "Collection of CMake modules for common build and development tasks" ":doc:`ROCm Data Center Tool `", "Simplifies administration and addresses key infrastructure challenges in AMD GPUs in cluster and data-center environments" - "`ROCm Debug Agent (ROCdebug-agent) `_ ", "Prints the state of all AMD GPU wavefronts that caused a queue error by sending a SIGQUIT signal to the process while the program is running" ":doc:`ROCm Debugger (ROCgdb) `", "Source-level debugger for Linux, based on the GNU Debugger (GDB)" ":doc:`ROCm SMI `", "C library for Linux that provides a user space interface for applications to monitor and control GPU applications" ":doc:`ROCm Validation Suite `", "Detects and troubleshoots common problems affecting AMD GPUs running in a high-performance computing environment" + ":doc:`ROCr Debug Agent `", "Prints the state of all AMD GPU wavefronts that caused a queue error by sending a SIGQUIT signal to the process while the program is running" ":doc:`TransferBench `", "Utility to benchmark simultaneous transfers between user-specified devices (CPUs/GPUs)" Compilers From e08c7d628bc18a8fd1b40daea04f91a6bab2b9be Mon Sep 17 00:00:00 2001 From: Peter Park Date: Tue, 11 Jun 2024 08:37:11 -0700 Subject: [PATCH 2/2] Remove aomp from What is ROCm? page (#3282) --- docs/what-is-rocm.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/what-is-rocm.rst b/docs/what-is-rocm.rst index 916ddf4e1..552ef83c7 100644 --- a/docs/what-is-rocm.rst +++ b/docs/what-is-rocm.rst @@ -119,7 +119,6 @@ Compilers .. csv-table:: :header: "Component", "Description" - "`AOMP `_", "Scripted build of `LLVM `_ and supporting software" "`FLANG `_", "An out-of-tree Fortran compiler targeting LLVM" "`hipCC `_ ", "Compiler driver utility that calls Clang or NVCC and passes the appropriate include and library options for the target compiler and HIP infrastructure" "`LLVM (amdclang) `_ ", "Toolkit for the construction of highly optimized compilers, optimizers, and runtime environments"