doc improvements for 1.0.0 part 2 (#330)

* update installation steps

* Github Issue #50 Adding README's for samples

* Making name change to ROCprofiler-SDK for consistency

* Fix HIP trace documentation

* Fix HSA trace in docs

* Fix kernel trace in docs

* Fixing memory copy and memory allocation traces

* runtime trace and sys trace doc update

* Fix scratch memory doc

* kernel naming and filtering options

* Adding collection period in docs

* Perfetto configs update

* summary output file

* kernel trace format fix

* update CHANGELOG

* Agent index doc update

* rocm-smi output

* group by queue option

* Updated --group-by-queue description

* perfetto visualization

---------

Co-authored-by: Ian Trowbridge <Ian.Trowbridge@amd.com>
This commit is contained in:
Bhardwaj, Gopesh
2025-04-16 02:00:07 +05:30
committato da GitHub
parent 4fbcfd142c
commit ca7cce9e81
32 ha cambiato i file con 744 aggiunte e 106 eliminazioni
+38 -5
Vedi File
@@ -17,8 +17,15 @@ ROCprofiler-SDK is supported only on Linux. The following distributions are test
- Ubuntu 20.04
- Ubuntu 22.04
- OpenSUSE 15.4
- RedHat 8.8
- Ubuntu 24.04
- OpenSUSE 15.5
- OpenSUSE 15.6
- Red Hat 8.8
- Red Hat 8.9
- Red Hat 8.10
- Red Hat 9.2
- Red Hat 9.3
- Red Hat 9.4
ROCprofiler-SDK might operate as expected on other `Linux distributions <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html#supported-operating-systems>`_, but has not been tested.
@@ -56,8 +63,8 @@ Install `CMake <https://cmake.org/>`_ version 3.21 (or later).
export PATH=${HOME}/.local/bin:${PATH}
Building ROCprofiler-SDK
------------------------
Building ROCprofiler-SDK from source
-------------------------------------
.. code-block:: bash
@@ -95,4 +102,30 @@ To run the built tests, ``cd`` into the ``rocprofiler-sdk-build`` directory and
.. code-block:: bash
/usr/local/bin/python -m pip install -r requirements.txt
/usr/local/bin/python -m pip install -r requirements.txt
Install via package manager
----------------------------
If you have ROCm version 6.2 or higher installed, you can use the package manager to install a pre-built copy of ROCProfiler-SDK.
.. tab-set::
.. tab-item:: Ubuntu
.. code-block:: shell
$ sudo apt install rocprofiler-sdk
.. tab-item:: Red Hat Enterprise Linux
.. code-block:: shell
$ sudo dnf install rocprofiler-sdk
.. tab-item:: SUSE Linux Enterprise Server
.. code-block:: shell
$ sudo zypper install rocprofiler-sdk