Skip to content

Commit

Permalink
fix sphinx warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Park <[email protected]>
  • Loading branch information
peterjunpark committed Oct 28, 2024
1 parent 9d07cc8 commit 06fc028
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 19 deletions.
7 changes: 4 additions & 3 deletions docs/how-to/analyze/grafana-gui.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. meta::
:description: ROCm Compute Profiler analysis: Grafana GUI
:keywords: ROCm Compute Profiler, ROCm, profiler, tool, Instinct, accelerator, Grafana, panels, GUI, import
:keywords: Omniperf, ROCm Compute Profiler, ROCm, profiler, tool,
Instinct, accelerator, Grafana, panels, GUI, import

********************
Grafana GUI analysis
Expand Down Expand Up @@ -169,7 +170,7 @@ convention:

.. code-block:: shell
rocprofiler-compute_<team>_<database>_<soc>
rocprofiler-compute_<team>_<database>_<soc>
For example:

Expand Down Expand Up @@ -268,7 +269,7 @@ ROCm Compute Profiler import for vcopy:
.. _panels:

ROCm Compute Profiler panels
---------------
----------------------------

There are currently 18 main panel categories available for analyzing the compute
workload performance. Each category contains several panels for close inspection
Expand Down
16 changes: 8 additions & 8 deletions docs/how-to/profile/mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Workload compilation

The following example demonstrates compilation of ``vcopy``.

.. code-block:: shell
.. code-block:: shell-session
$ hipcc vcopy.cpp -o vcopy
$ ls
Expand All @@ -74,7 +74,7 @@ The following example demonstrates compilation of ``vcopy``.
The following sample command profiles the ``vcopy`` workload.

.. code-block:: shell
.. code-block:: shell-session
$ rocprof-compute profile --name vcopy -- ./vcopy -n 1048576 -b 256
Expand Down Expand Up @@ -198,7 +198,7 @@ an Instinct MI210 vs an Instinct MI250.
profiling output is stored in ``log.txt``. Roofline-specific benchmark
results are stored in ``roofline.csv``.

.. code-block:: shell
.. code-block:: shell-session
$ ls workloads/vcopy/MI200/
total 112
Expand Down Expand Up @@ -263,7 +263,7 @@ enables incremental profiling and analysis.
The following example only gathers hardware counters for the shader sequencer
(SQ) and L2 cache (TCC) components, skipping all other hardware components.

.. code-block:: shell
.. code-block:: shell-session
$ rocprof-compute profile --name vcopy -b SQ TCC -- ./vcopy -n 1048576 -b 256
Expand Down Expand Up @@ -314,7 +314,7 @@ kernel name substring list to isolate desired kernels.
The following example demonstrates profiling isolating the kernel matching
substring ``vecCopy``.

.. code-block:: shell
.. code-block:: shell-session
$ rocprof-compute profile --name vcopy -k vecCopy -- ./vcopy -n 1048576 -b 256
Expand Down Expand Up @@ -349,7 +349,7 @@ Dispatch filtering is based on the *global* dispatch index of kernels in a run.
The following example profiles only the first kernel dispatch in the execution
of the application (note zero-based indexing).

.. code-block:: shell
.. code-block:: shell-session
$ rocprof-compute profile --name vcopy -d 0 -- ./vcopy -n 1048576 -b 256
Expand Down Expand Up @@ -408,7 +408,7 @@ Roofline only

The following example demonstrates profiling roofline data only:

.. code-block:: shell
.. code-block:: shell-session
$ rocprof-compute profile --name vcopy --roof-only -- ./vcopy -n 1048576 -b 256
Expand All @@ -427,7 +427,7 @@ The following example demonstrates profiling roofline data only:
An inspection of our workload output folder shows ``.pdf`` plots were generated
successfully.

.. code-block:: shell
.. code-block:: shell-session
$ ls workloads/vcopy/MI200/
total 48
Expand Down
2 changes: 0 additions & 2 deletions docs/install/core-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
Installing and deploying ROCm Compute Profiler
**********************************************

:doc:`HIP documentation <hip:index>`

ROCm Compute Profiler consists of two installation components.

* :ref:`ROCm Compute Profiler core installation <core-install>` (client-side)
Expand Down
12 changes: 6 additions & 6 deletions docs/install/grafana-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
:keywords: ROCm Compute Profiler, ROCm, profiler, tool, Instinct, accelerator, AMD,
install, deploy, Grafana, server, configuration, GUI

****************************************
Setting up a Grafana server for ROCm Compute Profiler
****************************************
***************************************************
Setting up Grafana server for ROCm Compute Profiler
***************************************************

A Grafana server is *not required* to profile or analyze performance data
from the CLI. It's a supplementary mechanism to help you import performance
Expand Down Expand Up @@ -166,10 +166,10 @@ connection is successful.
.. _grafana-import-dashboard-file:

Import the ROCm Compute Profiler dashboard file
----------------------------------
-----------------------------------------------

From the **Create** → **Import** page, upload the dashboard file,
``/dashboards/ROCm Compute Profiler_v{__VERSION__}_pub.json`` from the
``/dashboards/Omniperf_v{__VERSION__}_pub.json`` from the
:doc:`ROCm Compute Profiler tarball <core-install>`.

Edit both the dashboard **Name** and the **Unique identifier (UID)** fields to
Expand All @@ -185,7 +185,7 @@ uniquely identify the dashboard. Click **Import** to complete the process.
.. _grafana-select-workload:

Select and load the ROCm Compute Profiler workload
-------------------------------------
--------------------------------------------------

Once you have imported a dashboard you're ready to begin. Start by browsing
available dashboards and selecting the dashboard you have just imported.
Expand Down

0 comments on commit 06fc028

Please sign in to comment.