Skip to content

Commit

Permalink
Updated links in documentation. (#328)
Browse files Browse the repository at this point in the history
Updated to reflect new GitHub organization.
Fixed broken links to GitHub pages.

Signed-off-by: David Galiffi <David.Galiffi@amd.com>
  • Loading branch information
dgaliffiAMD authored Mar 21, 2024
1 parent 6222138 commit f571287
Show file tree
Hide file tree
Showing 19 changed files with 47 additions and 47 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ project(
VERSION ${OMNIPERF_VERSION}
LANGUAGES C
DESCRIPTION "OmniPerf"
HOMEPAGE_URL "https://github.com/AMDResearch/omniperf")
HOMEPAGE_URL "https://github.com/ROCm/omniperf")

include(ExternalProject)
include(GNUInstallDirs)
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## How to fork from us

To keep our development fast and conflict free, we recommend you to [fork](https://github.com/AMDResearch/omniperf/fork) our repository and start your work from our `dev` branch in your private repository.
To keep our development fast and conflict free, we recommend you to [fork](https://github.com/ROCm/omniperf/fork) our repository and start your work from our `dev` branch in your private repository.

Afterwards, git clone your repository to your local machine. But that is not it! To keep track of the original develop repository, add it as another remote.

```
git remote add mainline https://github.com/AMDResearch/omniperf.git
git remote add mainline https://github.com/ROCm/omniperf.git
git checkout dev
```

Expand All @@ -21,19 +21,19 @@ and apply your changes there.

### Did you find a bug?

- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/AMDResearch/omniperf/issues).
- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/ROCm/omniperf/issues).

- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/AMDResearch/omniperf/issues/new).
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ROCm/omniperf/issues/new).

### Did you write a patch that fixes a bug?

- Open a new GitHub [pull request](https://github.com/AMDResearch/omniperf/compare) with the patch.
- Open a new GitHub [pull request](https://github.com/ROCm/omniperf/compare) with the patch.

- Ensure the PR description clearly describes the problem and solution. If there is an existing GitHub issue open describing this bug, please include it in the description so we can close it.

- Ensure the PR is based on the `dev` branch of the Omniperf GitHub repository.

- Omniperf requires new commits to include a "Signed-off-by" token in the commit message (typically enabled via the `git commit -s` option), indicating your agreement to the projects's [Developer's Certificate of Origin](https://developercertificate.org/) and compatability with the project [LICENSE](https://github.com/AMDResearch/omniperf/blob/main/LICENSE):
- Omniperf requires new commits to include a "Signed-off-by" token in the commit message (typically enabled via the `git commit -s` option), indicating your agreement to the projects's [Developer's Certificate of Origin](https://developercertificate.org/) and compatability with the project [LICENSE](https://github.com/ROCm/omniperf/blob/main/LICENSE):


> (a) The contribution was created in whole or in part by me and I
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Ubuntu 20.04](https://github.com/AMDResearch/omniperf/actions/workflows/ubuntu-focal.yml/badge.svg)](https://github.com/AMDResearch/omniperf/actions/workflows/ubuntu-focal.yml)
[![RHEL 8](https://github.com/AMDResearch/omniperf/actions/workflows/opensuse.yml/badge.svg)](https://github.com/AMDResearch/omniperf/actions/workflows/opensuse.yml)
[![MI100](https://github.com/AMDResearch/omniperf/actions/workflows/mi100.yml/badge.svg?branch=2.x)](https://github.com/AMDResearch/omniperf/actions/workflows/mi100.yml)
[![Docs](https://github.com/AMDResearch/omniperf/actions/workflows/docs.yml/badge.svg)](https://amdresearch.github.io/omniperf/)
[![Ubuntu 20.04](https://github.com/ROCm/omniperf/actions/workflows/ubuntu-focal.yml/badge.svg)](https://github.com/ROCm/omniperf/actions/workflows/ubuntu-focal.yml)
[![RHEL 8](https://github.com/ROCm/omniperf/actions/workflows/opensuse.yml/badge.svg)](https://github.com/ROCm/omniperf/actions/workflows/opensuse.yml)
[![MI100](https://github.com/ROCm/omniperf/actions/workflows/mi100.yml/badge.svg?branch=2.x)](https://github.com/ROCm/omniperf/actions/workflows/mi100.yml)
[![Docs](https://github.com/ROCm/omniperf/actions/workflows/docs.yml/badge.svg)](https://rocm.github.io/omniperf/)
[![DOI](https://zenodo.org/badge/561919887.svg)](https://zenodo.org/badge/latestdoi/561919887)


Expand All @@ -14,7 +14,7 @@ targets usage on MI100 and MI200 accelerators.

* For more information on available features, installation steps, and
workload profiling and analysis, please refer to the online
[documentation](https://amdresearch.github.io/omniperf).
[documentation](https://rocm.github.io/omniperf).

* Omniperf is an AMD open source research project and is not supported
as part of the ROCm software stack. We welcome contributions and
Expand Down
2 changes: 1 addition & 1 deletion cmake/omniperf.lua.in
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ whatis("Name: omniperf")
whatis("Version: @OMNIPERF_FULL_VERSION@")
whatis("Keywords: Profiling, Performance, GPU")
whatis("Description: tool for GPU performance profiling")
whatis("URL: https://github.com/AMDResearch/omniperf")
whatis("URL: https://github.com/ROCm/omniperf")

-- Export environmental variables
local topDir="@CMAKE_INSTALL_PREFIX@"
Expand Down
12 changes: 6 additions & 6 deletions src/docs-1.x/analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](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.
> 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.
### Features

Expand Down Expand Up @@ -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 shows how to generate a report containing only metric 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/ROCm/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
--------
Expand Down Expand Up @@ -351,7 +351,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/analysis.html#grafana-based-gui)
interface](https://rocm.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.
Expand All @@ -365,7 +365,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://amdresearch.github.io/omniperf/faq.html) for more details on SSH tunneling.
See [FAQ](https://rocm.github.io/omniperf/faq.html) for more details on SSH tunneling.
```

#### Usage
Expand Down Expand Up @@ -420,7 +420,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/analysis.html#grafana-based-gui).
interface](https://rocm.github.io/omniperf/analysis.html#grafana-based-gui).
### Grafana-based GUI
Expand Down Expand Up @@ -470,7 +470,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/profiling.html#ip-block-profiling) section for this command.
> Refer to [*IP Block profiling*](https://rocm.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.
Expand Down
2 changes: 1 addition & 1 deletion src/docs-1.x/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,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://amdresearch.github.io/omniperf/analysis.html#grafana-gui-import) import section
Analysis*](https://rocm.github.io/omniperf/analysis.html#grafana-gui-import) import section
for more details on this.

```shell
Expand Down
2 changes: 1 addition & 1 deletion src/docs-1.x/high_level_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:maxdepth: 4
```

The [Omniperf](https://github.com/AMDResearch/omniperf) Tool is architecturally composed of three major components, as shown in the following figure.
The [Omniperf](https://github.com/ROCm/omniperf) Tool is architecturally composed of three major components, as shown in the following figure.

- **Omniperf Profiling**: Acquire raw performance counters via application replay based on the [rocProfiler](https://rocm.docs.amd.com/projects/rocprofiler/en/latest/rocprof.html). The counters are stored in a comma-seperated value, for further analyis. A set of MI200 specific micro benchmarks are also run to acquire the hierarchical roofline data. The roofline model is not available on earlier accelerators.

Expand Down
2 changes: 1 addition & 1 deletion src/docs-1.x/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to the [Omniperf](https://github.com/AMDResearch/omniperf) Documentation!
# Welcome to the [Omniperf](https://github.com/ROCm/omniperf) Documentation!

```eval_rst
.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion src/docs-1.x/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ defined as follows:

A typical install will begin by downloading the latest release tarball
available from the
[Releases](https://github.com/AMDResearch/omniperf/releases) section
[Releases](https://github.com/ROCm/omniperf/releases) section
of the Omniperf development site. From there, untar and descend into
the top-level directory as follows:

Expand Down
4 changes: 2 additions & 2 deletions src/docs-1.x/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
:maxdepth: 4
```

[Browse Omniperf source code on Github](https://github.com/AMDResearch/omniperf)
[Browse Omniperf source code on Github](https://github.com/ROCm/omniperf)

## Scope

MI Performance Profiler ([Omniperf](https://github.com/AMDResearch/omniperf)) is a system performance profiling tool for Machine Learning/HPC workloads running on AMD Instinct (tm) Accelerators. It is currently built on top of the [rocProfiler](https://rocm.docs.amd.com/projects/rocprofiler/en/latest/rocprof.html) to monitor hardware performance counters. The Omniperf tool primarily targets accelerators in the MI100 and MI200 families. Development is in progress to support MI300 and Radeon (tm) RDNA (tm) GPUs.
MI Performance Profiler ([Omniperf](https://github.com/ROCm/omniperf)) is a system performance profiling tool for Machine Learning/HPC workloads running on AMD Instinct (tm) Accelerators. It is currently built on top of the [rocProfiler](https://rocm.docs.amd.com/projects/rocprofiler/en/latest/rocprof.html) to monitor hardware performance counters. The Omniperf tool primarily targets accelerators in the MI100 and MI200 families. Development is in progress to support MI300 and Radeon (tm) RDNA (tm) GPUs.

## Features

Expand Down
4 changes: 2 additions & 2 deletions src/docs-1.x/profiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:maxdepth: 5
```

The [Omniperf](https://github.com/AMDResearch/omniperf) repository
The [Omniperf](https://github.com/ROCm/omniperf) repository
includes source code for a sample GPU compute workload,
__vcopy.cpp__. A copy of this file is available in the `share/sample`
subdirectory after a normal Omniperf installation, or via the
Expand Down Expand Up @@ -37,7 +37,7 @@ Releasing CPU memory
```

## Omniperf Profiling
The *omniperf* script, availible through the [Omniperf](https://github.com/AMDResearch/omniperf) repository, is used to aquire all necessary perfmon data through analysis of compute workloads.
The *omniperf* script, availible through the [Omniperf](https://github.com/ROCm/omniperf) repository, is used to aquire all necessary perfmon data through analysis of compute workloads.

**omniperf help:**
```shell-session
Expand Down
12 changes: 6 additions & 6 deletions src/docs-2.x/analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](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.
> 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.
### Features

Expand Down Expand Up @@ -266,7 +266,7 @@ Analysis mode = cli
2.1.30 -> L1I Fetch Latency
...
```
3. Choose your own customized subset of metrics with `-b` (a.k.a. `--block`), 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).
3. Choose your own customized subset of metrics with `-b` (a.k.a. `--block`), or build your own config following [config_template](https://github.com/ROCm/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
--------
Expand Down Expand Up @@ -363,7 +363,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/analysis.html#grafana-based-gui)
interface](https://rocm.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.
Expand All @@ -377,7 +377,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://amdresearch.github.io/omniperf/faq.html) for more details on SSH tunneling.
See [FAQ](https://rocm.github.io/omniperf/faq.html) for more details on SSH tunneling.
```
#### Usage
Expand Down Expand Up @@ -437,7 +437,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/analysis.html#grafana-based-gui).
interface](https://rocm.github.io/omniperf/analysis.html#grafana-based-gui).
### Grafana-based GUI
Expand Down Expand Up @@ -487,7 +487,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://amdresearch.github.io/omniperf/profiling.html#hardware-component-filtering) section for this command.
> Refer to [*Hardware Component Filtering*](https://rocm.github.io/omniperf/profiling.html#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.
Expand Down
2 changes: 1 addition & 1 deletion src/docs-2.x/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,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://amdresearch.github.io/omniperf/analysis.html#grafana-gui-import) import section
Analysis*](https://rocm.github.io/omniperf/analysis.html#grafana-gui-import) import section
for more details on this.

```shell
Expand Down
2 changes: 1 addition & 1 deletion src/docs-2.x/high_level_design.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:maxdepth: 4
```

The [Omniperf](https://github.com/AMDResearch/omniperf) Tool is architecturally composed of three major components, as shown in the following figure.
The [Omniperf](https://github.com/ROCm/omniperf) Tool is architecturally composed of three major components, as shown in the following figure.

- **Omniperf Profiling**: Acquire raw performance counters via application replay based on [rocProf](https://rocm.docs.amd.com/projects/rocprofiler/en/latest/rocprof.html). The counters are stored in a comma-seperated value, for further analysis. A set of MI200 specific micro benchmarks are also run to acquire the hierarchical roofline data. The roofline model is not available on earlier accelerators.

Expand Down
2 changes: 1 addition & 1 deletion src/docs-2.x/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to the [Omniperf](https://github.com/AMDResearch/omniperf) Documentation!
# Welcome to the [Omniperf](https://github.com/ROCm/omniperf) Documentation!

```eval_rst
.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion src/docs-2.x/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ defined as follows:

A typical install will begin by downloading the latest release tarball
available from the
[Releases](https://github.com/AMDResearch/omniperf/releases) section
[Releases](https://github.com/ROCm/omniperf/releases) section
of the Omniperf development site. From there, untar and descend into
the top-level directory as follows:

Expand Down
2 changes: 1 addition & 1 deletion src/docs-2.x/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This documentation was created to provide a detailed breakdown of all facets of

This project is proudly open source, and we welcome all feedback! For more details on how to contribute, please see our Contribution Guide.

[Browse Omniperf source code on Github](https://github.com/AMDResearch/omniperf)
[Browse Omniperf source code on Github](https://github.com/ROCm/omniperf)

## What is Omniperf

Expand Down
Loading

0 comments on commit f571287

Please sign in to comment.