Kandula, Venkateshwar reddy
6ec9526475
* Use custom .rst to make api doc more readable. * Update index.rst * Misc docs updates - doxygen source code fixes - updated doxygen files - fixed conf.py (does not generate code in source tree) * Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api_reference.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api/modules.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update source/docs/api-reference/rocprofiler-sdk_api/global_data_structures_topics_files.rst Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Duplicate * test warnings * Update CMakeLists.txt * Update rocprofiler-sdk.dox.in * Update update-docs.sh * fix docs build failures by -q -T flags. * set warn_as_error to NO. * test -W to suppress warnings. * remove -q flag from make. * reduce dot graph depth to 100 * Update custom docs target - docs target is now no longer part of the dependency list for the all target - installation of docs requires explicitly building the docs target (i.e. OPTIONAL install of _build/html/ folder) * add quit and trace mode back. * increase DOT_GRAPH_MAX_NODES to 500 back. * Format. --------- Co-authored-by: Venkateshwar Reddy Kandula <vkandula@amd.com> Co-authored-by: Jonathan R. Madsen <jonathanrmadsen@gmail.com> Co-authored-by: Bhardwaj, Gopesh <Gopesh.Bhardwaj@amd.com> Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com>
58 lines
2.6 KiB
ReStructuredText
58 lines
2.6 KiB
ReStructuredText
.. meta::
|
|
:description: ROCprofiler-SDK is a tooling infrastructure for profiling general-purpose GPU compute applications running on the ROCm software
|
|
:keywords: ROCprofiler-SDK tool, ROCprofiler-SDK library, rocprofv3, ROCprofiler-SDK API, ROCprofiler-SDK documentation
|
|
|
|
.. _index:
|
|
|
|
********************************
|
|
ROCprofiler-SDK documentation
|
|
********************************
|
|
|
|
ROCprofiler-SDK is a tooling infrastructure for profiling general-purpose GPU compute applications running on the ROCm software.
|
|
It supports application tracing to provide a big picture of the GPU application execution and kernel counter collection to provide low-level hardware details from the performance counters.
|
|
The ROCprofiler-SDK library provides runtime-independent APIs for tracing runtime calls and asynchronous activities such as GPU kernel dispatches and memory moves. The tracing includes callback APIs for runtime API tracing and activity APIs for asynchronous activity records logging.
|
|
|
|
In summary, ROCprofiler-SDK combines `ROCProfiler <https://rocm.docs.amd.com/projects/rocprofiler/en/latest/index.html>`_ and `ROCTracer <https://rocm.docs.amd.com/projects/roctracer/en/latest/index.html>`_.
|
|
You can utilize the ROCprofiler-SDK to develop a tool for profiling and tracing HIP applications on ROCm software.
|
|
|
|
The code is open and hosted at `<https://github.com/ROCm/rocprofiler-sdk>`_.
|
|
|
|
|
|
The documentation is structured as follows:
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Installation <install/installation>`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Samples <how-to/samples>`
|
|
* :ref:`using-rocprofv3`
|
|
* :ref:`using-rocprofiler-sdk-roctx`
|
|
* :ref:`using-rocprofv3-with-mpi`
|
|
* :ref:`using-pc-sampling`
|
|
|
|
.. grid-item-card:: API reference
|
|
|
|
* :doc:`Tool library <api-reference/tool_library>`
|
|
* :ref:`runtime-intercept-tables`
|
|
* :doc:`Buffered services <api-reference/buffered_services>`
|
|
* :doc:`Callback services <api-reference/callback_services>`
|
|
* :doc:`Counter collection services <api-reference/counter_collection_services>`
|
|
* :doc:`PC sampling <api-reference/pc_sampling>`
|
|
* :doc:`ROCprofiler-SDK API <api-reference/rocprofiler-sdk_api_reference>`
|
|
* :doc:`ROCTx API library <_doxygen/roctx/html/index>`
|
|
|
|
.. grid-item-card:: Conceptual
|
|
|
|
* :ref:`comparing-with-legacy-tools`
|
|
|
|
To contribute to the documentation, refer to
|
|
`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.
|
|
|
|
You can find licensing information on the
|
|
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.
|