From 0ea9dbf7a86d2a2aa366c20f5908b7c56f013ee1 Mon Sep 17 00:00:00 2001 From: "Baraldi, Giovanni" Date: Wed, 18 Jun 2025 14:10:18 +0200 Subject: [PATCH] Adding doc links for trace decoder, aqlprofile and viewer (#464) Adding interlinks for trace decoder, aqlprofile and viewer Co-authored-by: Giovanni Baraldi Co-authored-by: Bhardwaj, Gopesh [ROCm/rocprofiler-sdk commit: 9dadbbace5f4e9e343c938f1962f5b13e6ab70dc] --- .../source/docs/api-reference/thread_trace.rst | 4 ++++ .../source/docs/how-to/using-thread-trace.rst | 14 ++++++++++---- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/projects/rocprofiler-sdk/source/docs/api-reference/thread_trace.rst b/projects/rocprofiler-sdk/source/docs/api-reference/thread_trace.rst index c5ddf82596..78e1343076 100644 --- a/projects/rocprofiler-sdk/source/docs/api-reference/thread_trace.rst +++ b/projects/rocprofiler-sdk/source/docs/api-reference/thread_trace.rst @@ -15,6 +15,10 @@ ROCprofiler-SDK provides wrapper APIs for the ROCprof Trace Decoder, a library t Thread trace can generate large amounts of data, especially when profiling complex applications or longer execution runs. This might require handling potentially high volumes of trace data, so it’s recommended to implement appropriate filtering strategies to focus on the specific parts of interest in your application. +.. note:: + + ROCprof Trace Decoder is a binary-only library and can be found `here `_. + Thread trace service API ------------------------------------ diff --git a/projects/rocprofiler-sdk/source/docs/how-to/using-thread-trace.rst b/projects/rocprofiler-sdk/source/docs/how-to/using-thread-trace.rst index 7986979961..6d6b633707 100644 --- a/projects/rocprofiler-sdk/source/docs/how-to/using-thread-trace.rst +++ b/projects/rocprofiler-sdk/source/docs/how-to/using-thread-trace.rst @@ -35,11 +35,17 @@ Tracing and decoding is handled by ``rocprofv3`` while visualization is handled Prerequisites ========= -- aqlprofile for ROCm 7.0+ +- aqlprofile: + + * ROCm 7.x build, or + + * Early release can be `built from source `_ * Otherwise, ``rocprofv3`` throws error "INVALID_SHADER_DATA" or "Agent not supported". - -- Installation of ROCprof Trace Decoder component. For binary files, see `ROCprof trace decoder release page `_. + +- Installation of ROCprof Trace Decoder component: + + * For binary files, see `ROCprof trace decoder release page `_. * Default location is ``/opt/rocm/lib`` @@ -147,7 +153,7 @@ After the application finishes executing, ROCprof Trace Decoder runs automatical * Contains detailed tracing information in the form of .json files. - * This directory can be opened using ROCprof Compute Viewer. + * This directory can be opened using the `ROCprof Compute Viewer `_. - Raw files: