Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
405e6e8
Update doc.
xuchen-amd Jul 29, 2025
d48cfee
Update images.
xuchen-amd Jul 28, 2025
1638aff
Update docs.
xuchen-amd Jul 28, 2025
b91d7fb
Revert non-doc files.
xuchen-amd Aug 1, 2025
09c5771
Merge branch 'develop' into tui_kernel_selection_docs
xuchen-amd Aug 1, 2025
03aa1c5
Merge branch 'develop' into tui_kernel_selection_docs
xuchen-amd Aug 1, 2025
8984527
Merge branch 'develop' into tui_kernel_selection_docs
xuchen-amd Aug 5, 2025
1da0e24
Merge commit '8984527224c1f605fc675a9eb494dac45d738b71' into import/d…
systems-assistant[bot] Aug 6, 2025
b3f6725
Merge branch 'develop' into import/develop/xuchen-amd_rocprofiler-com…
xuchen-amd Aug 20, 2025
59c3296
Merge branch 'develop' into import/develop/xuchen-amd_rocprofiler-com…
xuchen-amd Aug 20, 2025
151532e
Merge branch 'develop' into import/develop/xuchen-amd_rocprofiler-com…
xuchen-amd Aug 25, 2025
c6b7093
Update docs.
xuchen-amd Aug 25, 2025
7ef0000
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Aug 27, 2025
32a3970
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Aug 27, 2025
ac9d88f
Update projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
xuchen-amd Aug 27, 2025
e5fc145
Update projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
xuchen-amd Aug 27, 2025
8a96221
Update projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
xuchen-amd Aug 27, 2025
416a7b4
Update projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
xuchen-amd Aug 27, 2025
ab710dd
Update projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
xuchen-amd Aug 27, 2025
2bbac4c
Update projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
xuchen-amd Aug 27, 2025
35f72e0
Merge branch 'develop' into import/develop/xuchen-amd_rocprofiler-com…
xuchen-amd Aug 27, 2025
152ab87
Changes based on review.
xuchen-amd Aug 27, 2025
8924c7d
Apply suggestion from @prbasyal-amd
xuchen-amd Aug 27, 2025
5130054
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Sep 4, 2025
1608fe2
Update projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
xuchen-amd Sep 4, 2025
4f6014e
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Sep 4, 2025
e335b28
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Sep 4, 2025
875be0c
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Sep 4, 2025
357764a
Update projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
xuchen-amd Sep 4, 2025
187cc6a
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Sep 4, 2025
7eed145
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Sep 4, 2025
c442570
Update projects/rocprofiler-compute/CHANGELOG.md
xuchen-amd Sep 4, 2025
9fca922
Apply suggestion from @prbasyal-amd
xuchen-amd Sep 4, 2025
bf5cc02
Merge branch 'develop' into import/develop/xuchen-amd_rocprofiler-com…
xuchen-amd Sep 4, 2025
7617fc7
Updated CHANGELOG.md
prbasyal-amd Sep 5, 2025
c347099
Merge branch 'develop' into import/develop/xuchen-amd_rocprofiler-com…
xuchen-amd Sep 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions projects/rocprofiler-compute/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,12 @@ Full documentation for ROCm Compute Profiler is available at [https://rocm.docs.

* Add notice for change in default output format to `rocpd` in a future release
* This is displayed when `--format-rocprof-output rocpd` is not used in profile mode

* When `--format-rocprof-output rocpd` is used, only pmc_perf.csv will be written to workload directory instead of mulitple csv files.

* Improve analysis block based filtering to accept metric id level filtering
* This can be used to collect individual metrics from various sections of analysis config

* CLI analysis mode baseline comparison will now only compare common metrics across workloads and will not show Metric ID
* Remove metrics from analysis configuration files which are explicitly marked as empty or None

* Change the basic view of TUI from aggregated analysis data to individual kernel analysis data
* Change the basic (default) view of TUI from aggregated analysis data to individual kernel analysis data
Comment thread
xuchen-amd marked this conversation as resolved.
Resolved

### Resolved issues

Expand All @@ -44,8 +40,7 @@ Full documentation for ROCm Compute Profiler is available at [https://rocm.docs.

* Usage of rocm-smi
* Hardware IP block based filtering has been removed in favor of analysis report block based filtering
* Remove aggregated analysis view from TUI mode

* Removed aggregated analysis view from TUI analyze mode
Comment thread
xuchen-amd marked this conversation as resolved.
Resolved

## ROCm Compute Profiler 3.2.1 for ROCm 7.0.0

Expand Down
Binary file not shown.
33 changes: 20 additions & 13 deletions projects/rocprofiler-compute/docs/how-to/analyze/tui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Text-based User Interface (TUI) analysis

ROCm Compute Profiler's analyze mode now supports a lightweight Text-based User Interface (TUI)
that provides an interactive terminal experience for enhanced usability. You can use the TUI
interface as a more visually engaging and interactive alternative to explore analysis results
compared to the standard :doc:`cli`. It provides enhanced visual feedback and easy navigation without
needing the extra setup of a full graphical interface. This analysis option is implemented as a
terminal-based interface that offers real-time visual feedback, keyboard shortcuts for common
interface as a more visually engaging and interactive alternative to explore individual kernel analysis
results compared to the standard :doc:`cli`. It provides enhanced visual feedback and easy navigation
without needing the extra setup of a full graphical interface. This analysis option is implemented as
a terminal-based interface that offers real-time visual feedback, keyboard shortcuts for common
actions, and improved readability with formatted output.

.. note::
Expand All @@ -30,18 +30,25 @@ For example:

$ rocprof-compute analyze --tui

2. To start the analysis, use the dropdown menu at the top left of the screen to select a single
workload from ``rocprof-compute profile`` generated output directories.
2. To start the individual kernel analysis, use the dropdown menu at the top left of the screen to select
Comment thread
xuchen-amd marked this conversation as resolved.
Resolved
a single workload from ``rocprof-compute profile`` generated output directories.

.. image:: ../../data/analyze/tui.png
.. image:: ../../data/analyze/tui_home.png
:align: center
:alt: ROCm Compute Profiler TUI home screen
:width: 800

3. You can see the center window update with collapsed contents. Uncollapse to view tables, charts,
and graphs visualizing the analysis data.
3. You can see the center window update with a top header for kernel selection and collapsed contents beneath.
Select a kernel of interest to load the corresponding analysis results, the default kernel selection is the top
Comment thread
xuchen-amd marked this conversation as resolved.
Resolved
kernel.
Comment thread
xuchen-amd marked this conversation as resolved.
Resolved

4. After the analysis results are loaded, you can start interactive analysis with detailed metrics.
.. image:: ../../data/analyze/tui_kernel_selection.png
:align: center
:alt: ROCm Compute Profiler TUI home screen
:width: 800

4. After the analysis results are loaded, you can start interactive analysis with detailed metrics by
Comment thread
xuchen-amd marked this conversation as resolved.
Resolved
uncollapse contents to view tables, charts, and graphs visualizing the analysis data.
Comment thread
xuchen-amd marked this conversation as resolved.
Resolved
The TUI supports basic keyboard shortcuts, including quit application commands for easy navigation.

TUI analysis structure
Expand All @@ -50,9 +57,9 @@ TUI analysis structure
Unlike the :doc:`cli` plain style interfaces, the TUI restructures the analysis workflow into four
hierarchical categories to provide a more organized, top-down analysis approach:

1. Top Stat
2. High Level analysis
3. Detailed block analysis
1. Kernel Selection Header with Top Stats
2. High Level Analysis
3. Detailed Block Analysis
4. Source Level analysis

You are recommended to follow this top-down hierarchical structure to conduct a thorough performance
Expand Down
18 changes: 9 additions & 9 deletions projects/rocprofiler-compute/docs/how-to/use.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,14 +152,6 @@ Analyze mode
To generate a lightweight GUI interface, you can add the ``--gui`` flag to your
analysis command.

Analyze mode now supports a lightweight Text-based User Interface (TUI) that
provides an interactive terminal experience for enhanced usability. To enable TUI mode,
use the ``--tui`` flag when running the analyze command:

.. code-block:: shell

$ rocprof-compute analyze --tui

This mode is a middle ground to the highly detailed ROCm Compute Profiler Grafana GUI and
is great if you want immediate access to a hardware component you’re already
familiar with.
Expand All @@ -168,7 +160,15 @@ Analyze mode

$ rocprof-compute analyze --help

See :doc:`analyze/mode` to learn about this mode in depth and to get started
Analyze mode now supports a lightweight Text-based User Interface (TUI) that
provides an interactive terminal experience for enhanced usability. To enable TUI mode,
use the ``--tui`` flag when running the analyze command:

.. code-block:: shell

$ rocprof-compute analyze --tui

See :doc:`analyze/mode` to learn about these modes in depth and to get started
with analysis using ROCm Compute Profiler.

.. _modes-database:
Expand Down