From 9c93449cc7dc3ca0db5667c19331d6f1cfafaf73 Mon Sep 17 00:00:00 2001 From: coleramos425 Date: Mon, 1 Apr 2024 13:54:46 -0500 Subject: [PATCH] Remove hardcoded URLs from docs in favor of relative links Signed-off-by: coleramos425 --- src/docs-2.x/analysis.md | 10 +++++----- src/docs-2.x/getting_started.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/docs-2.x/analysis.md b/src/docs-2.x/analysis.md index cf7e1f43e8..471fc31725 100644 --- a/src/docs-2.x/analysis.md +++ b/src/docs-2.x/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. ```{note} -Profiling results from the [aforementioned vcopy workload](https://rocm.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. +Profiling results from the [aforementioned vcopy workload](profiling.md#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. ``` ## CLI Analysis @@ -372,7 +372,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://rocm.github.io/omniperf/analysis.html#grafana-based-gui) +interface](analysis.md#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. @@ -386,7 +386,7 @@ between the desired web browser host (e.g. login node or remote workstation) and required. Alternatively, users may find it more convenient to download profiled workloads to perform analysis on their local system. -See [FAQ](https://rocm.github.io/omniperf/faq.html) for more details on SSH tunneling. +See [FAQ](faq.md) for more details on SSH tunneling. ``` #### Usage @@ -446,7 +446,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://rocm.github.io/omniperf/analysis.html#grafana-based-gui). +interface](analysis.md#grafana-based-gui). ### Grafana-based GUI @@ -496,7 +496,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 [*Hardware Component Filtering*](https://rocm.github.io/omniperf/profiling.html#hardware-component-filtering) section for this command. +> Refer to [*Hardware Component Filtering*](profiling.md#hardware-component-filtering) section for this command. By default, the entire application is profiled to collect performance counters for all hardware blocks, giving a complete view of where the workload stands in terms of performance optimization opportunities and bottlenecks. diff --git a/src/docs-2.x/getting_started.md b/src/docs-2.x/getting_started.md index f48aa80164..356fd3fe9a 100644 --- a/src/docs-2.x/getting_started.md +++ b/src/docs-2.x/getting_started.md @@ -79,7 +79,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*](https://rocm.github.io/omniperf/analysis.html#grafana-gui-import) import section + Analysis*](analysis.md#grafana-gui-import) import section for more details on this. ```shell