David Galiffi
d13617cf91
* Update branding in docs
* Rename image used in documentation
* Update names of code samples.
In the code snippets, the "-" is not valid. ex., rocprof-sys_ --> rocprofsys_
* Update ASCII art
* update Doxyfile strip_from_path
* Add a "Formerly known as" message.
* Fixed typo in product name
ROCm Systems Profiler, not ROCm Profiler System
* Add "Omnitrace" back to the metadata keywords
* Update "install via package manager" section
* Update paths to user API files
* Rename configuration and environment settings
* Update Doxyfiles
Update publisher name & ID to "AMD".
Update bundle ID to "rocprofiler-systems"
* Update docs/what-is-rocprof-sys.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/conceptual/data-collection-modes.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/tutorials/video-tutorials.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/conceptual/rocprof-sys-feature-set.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/configuring-runtime-options.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/configuring-validating-environment.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/general-tips-using-rocprof-sys.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/reference/rocprof-sys-glossary.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/reference/development-guide.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/instrumenting-rewriting-binary-application.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/install/quick-start.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Note that videos were recorded using the "Omnitrace" name.
* Rebase and update some file paths
* Update paths to doc images
* Update Omnitrace references in code snippets
* Rename examples still using the "omni" prefix.
* Update docs/how-to/performing-causal-profiling.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/profiling-python-scripts.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/sampling-call-stack.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/how-to/understanding-rocprof-sys-output.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
* Update docs/install/install.rst
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
---------
Co-authored-by: Peter Park <peter.park@amd.com>
Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
[ROCm/rocprofiler-systems commit: 032d39f15c]
66 linhas
2.9 KiB
ReStructuredText
66 linhas
2.9 KiB
ReStructuredText
.. meta::
|
|
:description: ROCm Systems Profiler documentation and reference
|
|
:keywords: rocprof-sys, rocprofiler-systems, Omnitrace, ROCm, profiler, tracking, visualization, tool, Instinct, accelerator, AMD
|
|
|
|
***********************
|
|
ROCm Systems Profiler documentation
|
|
***********************
|
|
|
|
ROCm Systems Profiler, formerly known as "Omnitrace", 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. To learn more, see :doc:`what-is-rocprof-sys`
|
|
|
|
The code is open and hosted at `<https://github.com/ROCm/rocprofiler-systems>`_.
|
|
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Install
|
|
|
|
* :doc:`Quick start <./install/quick-start>`
|
|
* :doc:`ROCm Systems Profiler installation <./install/install>`
|
|
|
|
|
|
The documentation is structured as follows:
|
|
|
|
.. grid:: 2
|
|
:gutter: 3
|
|
|
|
.. grid-item-card:: Tutorials
|
|
|
|
* `GitHub examples <https://github.com/ROCm/rocprofiler-systems/tree/amd-mainline/examples>`_
|
|
* :doc:`Video tutorials <./tutorials/video-tutorials>`
|
|
|
|
.. grid-item-card:: How to
|
|
|
|
* :doc:`Configuring and validating the ROCm Systems Profiler environment <./how-to/configuring-validating-environment>`
|
|
* :doc:`Configuring runtime options <./how-to/configuring-runtime-options>`
|
|
* :doc:`Sampling the call stack <./how-to/sampling-call-stack>`
|
|
* :doc:`Instrumenting and rewriting a binary application <./how-to/instrumenting-rewriting-binary-application>`
|
|
* :doc:`Performing causal profiling <./how-to/performing-causal-profiling>`
|
|
* :doc:`Understanding the ROCm Systems Profiler output <./how-to/understanding-rocprof-sys-output>`
|
|
* :doc:`Profiling Python scripts <./how-to/profiling-python-scripts>`
|
|
* :doc:`Using the ROCm Systems Profiler API <./how-to/using-rocprof-sys-api>`
|
|
* :doc:`General tips for using ROCm Systems Profiler <./how-to/general-tips-using-rocprof-sys>`
|
|
|
|
.. grid-item-card:: Conceptual
|
|
|
|
* :doc:`Data collection modes <./conceptual/data-collection-modes>`
|
|
* :doc:`The ROCm Systems Profiler feature set <./conceptual/rocprof-sys-feature-set>`
|
|
|
|
.. grid-item-card:: Reference
|
|
|
|
* :doc:`Development guide <./reference/development-guide>`
|
|
* :doc:`ROCm Systems Profiler glossary <./reference/rocprof-sys-glossary>`
|
|
* :doc:`API library <./doxygen/html/files>`
|
|
* :doc:`Class member functions <./doxygen/html/functions>`
|
|
* :doc:`Globals <./doxygen/html/globals>`
|
|
* :doc:`Classes, structures, and interfaces <./doxygen/html/annotated>`
|
|
|
|
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. |