Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update branding in documentation #442

Merged
merged 20 commits into from
Nov 6, 2024
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
update how to use analyze mode subsection
Signed-off-by: Peter Park <peter.park@amd.com>
peterjunpark committed Nov 5, 2024
commit 6cdd90cf3397e9780f46e9ad8714d2dbb7f2bf7f
58 changes: 29 additions & 29 deletions docs/how-to/analyze/cli.rst
Original file line number Diff line number Diff line change
@@ -19,7 +19,7 @@ This section provides an overview of ROCm Compute Profiler's CLI analysis featur
* :ref:`Filtering <cli-analysis-options>`: Hone in on a particular kernel,
GPU ID, or dispatch ID via post-process filtering.

Run ``omniperf analyze -h`` for more details.
Run ``rocprof-compute analyze -h`` for more details.

.. _cli-walkthrough:

@@ -28,16 +28,16 @@ Walkthrough

1. To begin, generate a high-level analysis report using ROCm Compute Profiler's ``-b`` (or ``--block``) flag.

.. code-block:: shell
.. code-block:: shell-session

$ omniperf analyze -p workloads/vcopy/MI200/ -b 2
$ rocprof-compute analyze -p workloads/vcopy/MI200/ -b 2

___ _ __
/ _ \ _ __ ___ _ __ (_)_ __ ___ _ __ / _|
| | | | '_ ` _ \| '_ \| | '_ \ / _ \ '__| |_
| |_| | | | | | | | | | | |_) | __/ | | _|
\___/|_| |_| |_|_| |_|_| .__/ \___|_| |_|
|_|
__ _
_ __ ___ ___ _ __ _ __ ___ / _| ___ ___ _ __ ___ _ __ _ _| |_ ___
| '__/ _ \ / __| '_ \| '__/ _ \| |_ _____ / __/ _ \| '_ ` _ \| '_ \| | | | __/ _ \
| | | (_) | (__| |_) | | | (_) | _|_____| (_| (_) | | | | | | |_) | |_| | || __/
|_| \___/ \___| .__/|_| \___/|_| \___\___/|_| |_| |_| .__/ \__,_|\__\___|
|_| |_|

Analysis mode = cli
[analysis] deriving ROCm Compute Profiler metrics...
@@ -134,16 +134,16 @@ Walkthrough

2. Use ``--list-metrics`` to generate a list of available metrics for inspection.

.. code-block:: shell
.. code-block:: shell-session

$ omniperf analyze -p workloads/vcopy/MI200/ --list-metrics gfx90a
$ rocprof-compute analyze -p workloads/vcopy/MI200/ --list-metrics gfx90a

___ _ __
/ _ \ _ __ ___ _ __ (_)_ __ ___ _ __ / _|
| | | | '_ ` _ \| '_ \| | '_ \ / _ \ '__| |_
| |_| | | | | | | | | | | |_) | __/ | | _|
\___/|_| |_| |_|_| |_|_| .__/ \___|_| |_|
|_|
__ _
_ __ ___ ___ _ __ _ __ ___ / _| ___ ___ _ __ ___ _ __ _ _| |_ ___
| '__/ _ \ / __| '_ \| '__/ _ \| |_ _____ / __/ _ \| '_ ` _ \| '_ \| | | | __/ _ \
| | | (_) | (__| |_) | | | (_) | _|_____| (_| (_) | | | | | | |_) | |_| | || __/
|_| \___/ \___| .__/|_| \___/|_| \___\___/|_| |_| |_| .__/ \__,_|\__\___|
|_| |_|

Analysis mode = cli
[analysis] deriving ROCm Compute Profiler metrics...
@@ -186,13 +186,13 @@ Walkthrough

3. Choose your own customized subset of metrics with the ``-b`` (or ``--block``)
option. Or, build your own configuration following
`config_template <https://github.com/ROCm/omniperf/blob/amd-mainline/src/rocprof_compute_soc/analysis_configs/panel_config_template.yaml>`_.
`config_template <https://github.com/ROCm/rocprofiler-compute/blob/amd-mainline/src/rocprof_compute_soc/analysis_configs/panel_config_template.yaml>`_.
The following snippet shows how to generate a report containing only metric 2
(:doc:`System Speed-of-Light </conceptual/system-speed-of-light>`).

.. code-block:: shell
.. code-block:: shell-session

$ omniperf analyze -p workloads/vcopy/MI200/ -b 2
$ rocprof-compute analyze -p workloads/vcopy/MI200/ -b 2

--------
Analyze
@@ -291,22 +291,22 @@ More analysis options
Single run
.. code-block:: shell

$ omniperf analyze -p workloads/vcopy/MI200/
$ rocprof-compute analyze -p workloads/vcopy/MI200/

List top kernels and dispatches
.. code-block:: shell

$ omniperf analyze -p workloads/vcopy/MI200/ --list-stats
$ rocprof-compute analyze -p workloads/vcopy/MI200/ --list-stats

List metrics
.. code-block:: shell

$ omniperf analyze -p workloads/vcopy/MI200/ --list-metrics gfx90a
$ rocprof-compute analyze -p workloads/vcopy/MI200/ --list-metrics gfx90a

Show System Speed-of-Light and CS_Busy blocks only
.. code-block:: shell

$ omniperf analyze -p workloads/vcopy/MI200/ -b 2 5.1.0
$ rocprof-compute analyze -p workloads/vcopy/MI200/ -b 2 5.1.0

.. note::

@@ -319,7 +319,7 @@ Filter kernels

.. code-block::

$ omniperf analyze -p workloads/vcopy/MI200/ --list-stats
$ rocprof-compute analyze -p workloads/vcopy/MI200/ --list-stats

Analysis mode = cli
[analysis] deriving ROCm Compute Profiler metrics...
@@ -344,9 +344,9 @@ Filter kernels
``vecCopy(double*, double*, double*, int, int) [clone .kd]`` at index ``0``.
Then, use this index to apply the filter via ``-k`` or ``--kernels``.

.. code-block:: shell
.. code-block:: shell-session

$ omniperf analyze -p workloads/vcopy/MI200/ -k 0
$ rocprof-compute analyze -p workloads/vcopy/MI200/ -k 0

Analysis mode = cli
[analysis] deriving ROCm Compute Profiler metrics...
@@ -369,10 +369,10 @@ Filter kernels
Baseline comparison
.. code-block:: shell

omniperf analyze -p workload1/path/ -p workload2/path/
rocprof-compute analyze -p workload1/path/ -p workload2/path/

OR

.. code-block:: shell

omniperf analyze -p workload1/path/ -k 0 -p workload2/path/ -k 1
rocprof-compute analyze -p workload1/path/ -k 0 -p workload2/path/ -k 1
50 changes: 25 additions & 25 deletions docs/how-to/analyze/grafana-gui.rst
Original file line number Diff line number Diff line change
@@ -169,13 +169,13 @@ convention:

.. code-block:: shell

omniperf_<team>_<database>_<soc>
rocprofiler-compute_<team>_<database>_<soc>

For example:

.. code-block:: shell

omniperf_asw_vcopy_mi200
rocprofiler-compute_asw_vcopy_mi200

When using :ref:`database mode <modes-database>`, be sure to tailor the
connection options to the machine hosting your
@@ -187,20 +187,20 @@ called ``dummybox``.

.. code-block:: shell-session

$ omniperf database --help
$ rocprof-compute database --help
usage:

omniperf database <interaction type> [connection options]
rocprof-compute database <interaction type> [connection options]



-------------------------------------------------------------------------------

Examples:

omniperf database --import -H pavii1 -u temp -t asw -w workloads/vcopy/mi200/
rocprof-compute database --import -H pavii1 -u temp -t asw -w workloads/vcopy/mi200/

omniperf database --remove -H pavii1 -u temp -w omniperf_asw_sample_mi200
rocprof-compute database --remove -H pavii1 -u temp -w rocprofiler-compute_asw_sample_mi200

-------------------------------------------------------------------------------

@@ -229,37 +229,37 @@ called ``dummybox``.


ROCm Compute Profiler import for vcopy:
^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: shell
.. code-block:: shell-session

$ omniperf database --import -H dummybox -u temp -t asw -w workloads/vcopy/mi200/
$ rocprof-compute database --import -H dummybox -u temp -t asw -w workloads/vcopy/mi200/

___ _ __
/ _ \ _ __ ___ _ __ (_)_ __ ___ _ __ / _|
| | | | '_ ` _ \| '_ \| | '_ \ / _ \ '__| |_
| |_| | | | | | | | | | | |_) | __/ | | _|
\___/|_| |_| |_|_| |_|_| .__/ \___|_| |_|
|_|
__ _
_ __ ___ ___ _ __ _ __ ___ / _| ___ ___ _ __ ___ _ __ _ _| |_ ___
| '__/ _ \ / __| '_ \| '__/ _ \| |_ _____ / __/ _ \| '_ ` _ \| '_ \| | | | __/ _ \
| | | (_) | (__| |_) | | | (_) | _|_____| (_| (_) | | | | | | |_) | |_| | || __/
|_| \___/ \___| .__/|_| \___/|_| \___\___/|_| |_| |_| .__/ \__,_|\__\___|
|_| |_|


Pulling data from /home/auser/repos/omniperf/sample/workloads/vcopy/MI200
Pulling data from /home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200
The directory exists
Found sysinfo file
KernelName shortening enabled
Kernel name verbose level: 2
Password:
Password received
-- Conversion & Upload in Progress --
0%| | 0/11 [00:00<?, ?it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/SQ_IFETCH_LEVEL.csv
9%|█████████████████▉ | 1/11 [00:00<00:01, 8.53it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/pmc_perf.csv
18%|███████████████████████████████████▊ | 2/11 [00:00<00:01, 6.99it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/SQ_INST_LEVEL_SMEM.csv
27%|█████████████████████████████████████████████████████▋ | 3/11 [00:00<00:01, 7.90it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/SQ_LEVEL_WAVES.csv
36%|███████████████████████████████████████████████████████████████████████▋ | 4/11 [00:00<00:00, 8.56it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/SQ_INST_LEVEL_LDS.csv
45%|█████████████████████████████████████████████████████████████████████████████████████████▌ | 5/11 [00:00<00:00, 9.00it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/SQ_INST_LEVEL_VMEM.csv
55%|███████████████████████████████████████████████████████████████████████████████████████████████████████████▍ | 6/11 [00:00<00:00, 9.24it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/sysinfo.csv
64%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████▎ | 7/11 [00:00<00:00, 9.37it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/roofline.csv
82%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████▏ | 9/11 [00:00<00:00, 12.60it/s]/home/auser/repos/omniperf/sample/workloads/vcopy/MI200/timestamps.csv
0%| | 0/11 [00:00<?, ?it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/SQ_IFETCH_LEVEL.csv
9%|█████████████████▉ | 1/11 [00:00<00:01, 8.53it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/pmc_perf.csv
18%|███████████████████████████████████▊ | 2/11 [00:00<00:01, 6.99it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/SQ_INST_LEVEL_SMEM.csv
27%|█████████████████████████████████████████████████████▋ | 3/11 [00:00<00:01, 7.90it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/SQ_LEVEL_WAVES.csv
36%|███████████████████████████████████████████████████████████████████████▋ | 4/11 [00:00<00:00, 8.56it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/SQ_INST_LEVEL_LDS.csv
45%|█████████████████████████████████████████████████████████████████████████████████████████▌ | 5/11 [00:00<00:00, 9.00it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/SQ_INST_LEVEL_VMEM.csv
55%|███████████████████████████████████████████████████████████████████████████████████████████████████████████▍ | 6/11 [00:00<00:00, 9.24it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/sysinfo.csv
64%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████▎ | 7/11 [00:00<00:00, 9.37it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/roofline.csv
82%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████▏ | 9/11 [00:00<00:00, 12.60it/s]/home/auser/repos/rocprofiler-compute/sample/workloads/vcopy/MI200/timestamps.csv
100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 11/11 [00:00<00:00, 11.05it/s]
9 collections added.
Workload name uploaded
2 changes: 1 addition & 1 deletion docs/how-to/analyze/standalone-gui.rst
Original file line number Diff line number Diff line change
@@ -34,7 +34,7 @@ desired analysis command. For example:

.. code-block:: shell

$ omniperf analyze -p workloads/vcopy/MI200/ --gui
$ rocprof-compute analyze -p workloads/vcopy/MI200/ --gui

___ _ __
/ _ \ _ __ ___ _ __ (_)_ __ ___ _ __ / _|