diff --git a/projects/rocprofiler-compute/src/docs/analysis.md b/projects/rocprofiler-compute/src/docs/analysis.md index 51050c2bf5..f355ba7c67 100644 --- a/projects/rocprofiler-compute/src/docs/analysis.md +++ b/projects/rocprofiler-compute/src/docs/analysis.md @@ -12,7 +12,7 @@ While analyzing with the CLI offers quick and straightforward access to Omniperf See sections below for more information on each. ## CLI Analysis -> Profiling results from the [aforementioned vcopy workload]() will be used in the following sections to demonstrate the use of Omniperf in MI GPU performance analysis. Unless otherwise noted, the performance analysis is done on the MI200 platform. +> Profiling results from the [aforementioned vcopy workload](https://amdresearch.github.io/omniperf/profiling.html#workload-compilation) will be used in the following sections to demonstrate the use of Omniperf in MI GPU performance analysis. Unless otherwise noted, the performance analysis is done on the MI200 platform. ### Features @@ -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. `--filter-metrics`), or build your own config following [config_template](). 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. `--filter-metrics`), 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). ```shell $ omniperf analyze -p workloads/vcopy/mi200/ -b 2 -------- @@ -308,7 +308,7 @@ be generated directly from the command-line. This option is provided as an alternative for users wanting to explore profiling results graphically, but without the additional setup requirements or server-side overhead of Omniperf's detailed [Grafana -interface](https://amdresearch.github.io/omniperf/grafana_analyzer.html#) +interface](https://amdresearch.github.io/omniperf/analysis.html#grafana-based-gui) option. The standalone GUI analyzer is provided as simple [Flask](https://flask.palletsprojects.com/en/2.2.x/) application allowing users to view results from within a web browser. @@ -375,7 +375,7 @@ Once you have applied a filter, you will also see several additional sections become available with detailed metrics specific to that area of AMD hardware. These detailed sections mirror the data displayed in Omniperf's [Grafana -interface](https://amdresearch.github.io/omniperf/grafana_analyzer.html#). +interface](https://amdresearch.github.io/omniperf/analysis.html#grafana-based-gui). ### Grafana-based GUI @@ -425,7 +425,7 @@ For example, if one wants to inspect Dispatch Range from 17 to 48, inclusive, th ##### Incremental Profiling Omniperf supports incremental profiling to significantly speed up performance analysis. -> Refer to [*IP Block profiling*](https://amdresearch.github.io/omniperf/performance_analysis.html#ip-block-profiling) section for this command. +> Refer to [*IP Block profiling*](https://amdresearch.github.io/omniperf/profiling.html#ip-block-profiling) section for this command. By default, the entire application is profiled to collect perfmon counter for all IP blocks, giving a system level view of where the workload stands in terms of performance optimization opportunities and bottlenecks. diff --git a/projects/rocprofiler-compute/src/docs/getting_started.md b/projects/rocprofiler-compute/src/docs/getting_started.md index c5c13d6322..6e1bf1de08 100644 --- a/projects/rocprofiler-compute/src/docs/getting_started.md +++ b/projects/rocprofiler-compute/src/docs/getting_started.md @@ -70,7 +70,7 @@ Modes change the fundamental behavior of the Omniperf command line tool. Dependi - **Database**: Our detailed Grafana GUI is built on a MongoDB database. `--import` profiling results to the DB to interact with the workload in Grafana or `--remove` the workload from the DB. Connection options will need to be specified. See the [*Grafana - Analysis*](grafana_analyzer.md#grafana-gui-import) import section + Analysis*](https://amdresearch.github.io/omniperf/analysis.html#grafana-gui-import) import section for more details on this. ```shell