From 064debf356f1bba48665e7af8e0f6e593e156772 Mon Sep 17 00:00:00 2001 From: coleramos425 Date: Thu, 17 Aug 2023 09:50:38 -0500 Subject: [PATCH] Documentation enhancements Signed-off-by: coleramos425 --- src/docs/analysis.md | 8 ++++---- src/docs/profiling.md | 6 +++--- src/omniperf | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/docs/analysis.md b/src/docs/analysis.md index af0234786c..9b68249c4f 100644 --- a/src/docs/analysis.md +++ b/src/docs/analysis.md @@ -25,7 +25,7 @@ Run `omniperf analyze -h` for more details. ### Recommended workflow -1) Do a comprehensive analysis with Omniperf CLI at the beginning. +1) To begin, generate a comprehensive analysis report with Omniperf CLI. ```shell-session $ omniperf analyze -p workloads/vcopy/mi200/ @@ -171,7 +171,7 @@ $ omniperf analyze -p workloads/vcopy/mi200/ --list-metrics gfx90a ├─────────┼─────────────────────────────┤ ... ``` - 2. Choose your own customized subset of metrics with `-b` (a.k.a. `--metric`), or build your own config following [config_template](https://github.com/AMDResearch/omniperf/blob/main/src/omniperf_analyze/configs/panel_config_template.yaml). Below we'll inspect block 2 (a.k.a. System Speed-of-Light). + 2. Choose your own customized subset of metrics with `-b` (a.k.a. `--metric`), or build your own config following [config_template](https://github.com/AMDResearch/omniperf/blob/main/src/omniperf_analyze/configs/panel_config_template.yaml). Below shows how to generate a report containing only metric 2 (a.k.a. System Speed-of-Light). ```shell-session $ omniperf analyze -p workloads/vcopy/mi200/ -b 2 -------- @@ -252,9 +252,9 @@ Analyze │ 2.1.28 │ Instr Fetch Latency │ 21.729248046875 │ Cycles │ │ │ ╘═════════╧═══════════════════════════╧═══════════════════════╧══════════════════╧════════════════════╧════════════════════════╛ ``` -> **Note:** Some cells may be blank indicating a missing/unavailible hardware counter or NULL value +> **Note:** Some cells may be blank indicating a missing/unavailable hardware counter or NULL value -3. Quick optimization iterations and profiling with customized metrics. +3. Optimizatize application, iterate, and re-profile to inspect performance changes. 4. Redo a comprehensive analysis with Omniperf CLI at any milestone or at the end. ### Demo diff --git a/src/docs/profiling.md b/src/docs/profiling.md index e73c8d4654..56c234604e 100644 --- a/src/docs/profiling.md +++ b/src/docs/profiling.md @@ -238,9 +238,9 @@ To reduce profiling time and the counters collected one may use profiling filter Filtering Options: -- The `-k` \ flag allows for kernel filtering. Useage is equivalent with the current rocprof utility (see details below). +- The `-k` \ flag allows for kernel filtering. Useage is equivalent with the current rocprof utility ([see details below](#kernel-filtering)). -- The `-d` \ flag allows for dispatch ID filtering. Useage is equivalent with the current rocprof utility (see details below). +- The `-d` \ flag allows for dispatch ID filtering. Useage is equivalent with the current rocprof utility ([see details below](#dispatch-filtering)). - The `-b` \ allows system profiling on one or more selected IP blocks to speed up the profiling process. One can gradually incorporate more IP blocks, without overwriting performance data acquired on other IP blocks. @@ -330,7 +330,7 @@ ROCProfiler: input from "/tmp/rpl_data_230411_170300_29696/input0.xml" #### Dispatch Filtering Dispatch filtering is based on the *global* dispatch index of kernels in a run. -The following example profiles only the 0th dispatched kernel: +The following example profiles only the 0th dispatched kernel in execution of the application: ```shell-session $ omniperf profile --name vcopy -d 0 -- ./vcopy 1048576 256 Resolving rocprof diff --git a/src/omniperf b/src/omniperf index eb7a75ff84..4aac533885 100755 --- a/src/omniperf +++ b/src/omniperf @@ -771,7 +771,7 @@ def main(): else: throw_parse_error( my_parser, - "Profiling command required. Pass this after -- at the end of your options.\n\ti.e. omniperf profile -n vcopy -- ./vcopy 1048576 256", + "Profiling command required. Pass application executable after -- at the end of options.\n\ti.e. omniperf profile -n vcopy -- ./vcopy 1048576 256", ) # Name cannot exceed MongoDB max len if len(args.name) > 35: