Peter Park
a70034055e
* fix typo * fix `Lexing literal_block` docutils warning * fix `Title underline too short` docutils warning * use consistent file type * fix `Malformed table` error * improve index.rst and front-load TOC
29 lines
1.7 KiB
ReStructuredText
29 lines
1.7 KiB
ReStructuredText
.. meta::
|
|
:description: ROCm Systems Profiler introduction, explanation, and reference
|
|
:keywords: rocprof-sys, rocprofiler-systems, Omnitrace, ROCm, profiler, explanation, introduction, what is, tracking, visualization, tool, Instinct, accelerator, AMD
|
|
|
|
******************************
|
|
What is ROCm Systems Profiler?
|
|
******************************
|
|
|
|
ROCm Systems Profiler is designed for the high-level profiling and comprehensive tracing
|
|
of applications running on the CPU or the CPU and GPU. It supports dynamic binary
|
|
instrumentation, call-stack sampling, and various other features for determining
|
|
which function and line number are currently executing.
|
|
|
|
A visualization of the comprehensive ROCm Systems Profiler results can be observed in any modern
|
|
web browser. Upload the Perfetto (``.proto``) output files produced by ROCm Systems Profiler at
|
|
`ui.perfetto.dev <https://ui.perfetto.dev/>`_ to see the details.
|
|
|
|
Aggregated high-level results are available as human-readable text files and
|
|
JSON files for programmatic analysis. The JSON output files are compatible with the
|
|
`hatchet <https://github.com/hatchet/hatchet>`_ Python package. Hatchet converts
|
|
the performance data into pandas data frames and facilitates multi-run comparisons, filtering,
|
|
and visualization in Jupyter notebooks.
|
|
|
|
To use ROCm Systems Profiler for instrumentation, follow these two configuration steps:
|
|
|
|
#. Indicate the functions and modules to :doc:`instrument <./how-to/instrumenting-rewriting-binary-application>` in the target binaries, including the executable and any libraries
|
|
#. Specify the :doc:`instrumentation parameters <./how-to/configuring-runtime-options>` to use when the instrumented binaries are launched
|
|
|