.. meta::
  :description: Documentation of the installation, configuration, use of the ROCProfiler SDK, and rocprofv3 command-line tool 
  :keywords: ROCProfiler SDK tool, ROCProfiler SDK library, rocprofv3, ROCm, API, reference

.. _index:

******************************************
ROCProfiler SDK documentation
******************************************

ROCProfiler SDK is a comprehensive library that provides APIs for profiling and tracing HIP applications on AMD ROCm Software. To learn more, see :ref:`what-is-rocprof-sdk`

You can access ROCProfiler SDK on our `GitHub repository <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:`Using rocprofv3 <how-to/using-rocprofv3>`
    * :doc:`Samples <how-to/samples>`
    
  .. grid-item-card:: API reference

    * :doc:`API library <_doxygen/html/index>`
    
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.