ROCProfiler documentation

ROCProfiler documentation#

ROCProfiler is a powerful tool for profiling HIP and ROCm applications on AMD ROCm software. Profiling is used to identify application performance bottlenecks and optimize their performance. ROCProfiler offers a library for developing applications with profiling features and a command-line interface (CLI) tool for profiling compiled applications. The library and CLI tool for the first version of ROCProfiler are named ROCProfiler and rocprof, respectively, whereas the library and the CLI tools for the second version of ROCProfiler are ROCProfilerV2, rocprofv2, and rocsys. ROCProfiler and ROCProfilerV2 provide:

  • Application tracing: Traces the execution of an application with timestamps for the start and end of each API call, as well as kernel execution.

  • Performance counter collection: Collects performance counters for each API call and kernel execution.

Important

Development and support for ROCTracer and ROCProfiler (rocprof and rocprofv2) will phase out in favor of ROCprofiler-SDK (rocprofv3) in upcoming ROCm releases. Going forward, only critical defect fixes will be addressed for older versions of profiling tools and libraries. Upgrade to the latest version of ROCprofiler-SDK (rocprofv3) library to ensure continued support and access to new features.

Note

ROCprofiler-SDK is the newer profiling tool. See Comparing ROCprofiler-SDK with ROCProfiler and ROCProfilerV2 for comparison between the latest and older versions of ROCm profiling tools.

The code is open and hosted at ROCm/rocprofiler.

Install

The documentation is structured as follows:

Tutorials
How to
References

To contribute to the documentation, refer to Contributing to ROCm.

You can find licensing information on the Licensing page.