diff --git a/projects/rocprofiler-compute/CONTRIBUTING.md b/projects/rocprofiler-compute/CONTRIBUTING.md index a4bc406959..8b6dfd6eed 100644 --- a/projects/rocprofiler-compute/CONTRIBUTING.md +++ b/projects/rocprofiler-compute/CONTRIBUTING.md @@ -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/ROCm/rocprofiler-compute/fork) our repository and start your work from our `develop` branch in your private repository. +To keep our development fast and conflict free, we recommend you to [fork](https://github.com/ROCm/rocm-systems/forks) our repository and start your work from our `develop` 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/ROCm/rocprofiler-compute.git +git remote add mainline https://github.com/ROCm/rocm-systems.git git checkout develop ``` @@ -21,17 +21,17 @@ and apply your changes there. For more help reference GitHub's ['About Forking'] ### Did you find a bug? -- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/ROCm/rocprofiler-compute/issues). +- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/ROCm/rocm-systems/issues). -- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ROCm/rocprofiler-compute/issues/new). +- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ROCm/rocm-systems/issues/new). ### Did you write a patch that fixes a bug? -- Open a new GitHub [pull request](https://github.com/ROCm/rocprofiler-compute/compare) with the patch. +- Open a new GitHub [pull request](https://github.com/ROCm/rocm-systems/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 `develop` branch of the ROCm Compute Profiler GitHub repository. +- Ensure the PR is based on the `develop` branch of the ROCm Systems GitHub repository. > [!TIP] > To ensure you meet all formatting requirements before publishing, we recommend you utilize our included [*pre-commit hooks*](https://pre-commit.com/#introduction). For more information on how to use pre-commit hooks please see the [section below](#using-pre-commit-hooks). @@ -184,7 +184,7 @@ You can also disable specific linting rules for a line by using `# noqa: `_. + `config_template `_. The following snippet shows how to generate a report containing only metric 2 (:doc:`System Speed-of-Light `). diff --git a/projects/rocprofiler-compute/docs/how-to/profile/mode.rst b/projects/rocprofiler-compute/docs/how-to/profile/mode.rst index 4a2f82b0f2..c3296c51d9 100644 --- a/projects/rocprofiler-compute/docs/how-to/profile/mode.rst +++ b/projects/rocprofiler-compute/docs/how-to/profile/mode.rst @@ -47,7 +47,7 @@ Run ``rocprof-compute profile -h`` for more details. See Profiling example ----------------- -The ``__ repository +The ``__ 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 ROCm Compute Profiler installation, or via the ``$ROCPROFCOMPUTE_SHARE/sample`` directory when @@ -239,11 +239,6 @@ of the underlying ``rocprof`` tool. The following formats are supported: * The generated csv files across multiple runs of rocprof are processed and dumped into the workload directory as csv files. * Multiple csv files are merged into single pmc_perf.csv file in workload directory. -* ``json`` format: - * Ask underlying rocprof tool to dump raw performance counter data in json format. - * The generated json files across multiple runs of rocprof are processed and dumped into the workload directory as csv files. - * Multiple csv files are merged into single pmc_perf.csv file in workload directory. - * ``rocpd`` format: * Ask underlying rocprof tool to dump raw performance counter data in rocpd format. * Multiple ``rocpd`` database files containding counter collection data are merged into a single csv under the workload folder. diff --git a/projects/rocprofiler-compute/docs/index.rst b/projects/rocprofiler-compute/docs/index.rst index 60cfa5feb6..8545866109 100644 --- a/projects/rocprofiler-compute/docs/index.rst +++ b/projects/rocprofiler-compute/docs/index.rst @@ -15,7 +15,11 @@ If you're new to ROCm Compute Profiler, familiarize yourself with the tool by re chapters that follow and gradually learn its more advanced features. To get started, see :doc:`What is ROCm Compute Profiler? `. -ROCm Compute Profiler is open source and hosted at ``__. +ROCm Compute Profiler is open source and hosted at ``__. + +.. note:: + + The rocprofiler-compute repository for ROCm 7.0 and earlier is located at ``_. .. grid:: 2 :gutter: 3 diff --git a/projects/rocprofiler-compute/docs/install/core-install.rst b/projects/rocprofiler-compute/docs/install/core-install.rst index 87e8dd151f..d2ef8df773 100644 --- a/projects/rocprofiler-compute/docs/install/core-install.rst +++ b/projects/rocprofiler-compute/docs/install/core-install.rst @@ -111,7 +111,7 @@ Install from source ------------------- #. A typical install begins by downloading the latest release tarball available - from ``__. From there, untar and + from ``__. From there, untar and navigate into the top-level directory. .. diff --git a/projects/rocprofiler-compute/docs/tutorial/includes/vector-memory-operation-counting.rst b/projects/rocprofiler-compute/docs/tutorial/includes/vector-memory-operation-counting.rst index 4cfb875f40..9c52075ac6 100644 --- a/projects/rocprofiler-compute/docs/tutorial/includes/vector-memory-operation-counting.rst +++ b/projects/rocprofiler-compute/docs/tutorial/includes/vector-memory-operation-counting.rst @@ -623,7 +623,7 @@ manner. See for further reading on this instruction type. We develop a `simple -kernel `__ +kernel `__ that uses stack memory: .. code-block:: cpp diff --git a/projects/rocprofiler-compute/docs/tutorial/profiling-by-example.rst b/projects/rocprofiler-compute/docs/tutorial/profiling-by-example.rst index faa00b5ec3..8ff9fcc7e0 100644 --- a/projects/rocprofiler-compute/docs/tutorial/profiling-by-example.rst +++ b/projects/rocprofiler-compute/docs/tutorial/profiling-by-example.rst @@ -7,7 +7,7 @@ Profiling by example ******************** The following examples refer to sample :doc:`HIP ` code located in -:fab:`github` :dev-sample:`ROCm/rocprofiler-compute/blob/amd-mainline/sample <>` +:fab:`github` :dev-sample:`ROCm/rocm-systems/blob/develop/projects/rocprofiler-compute/sample <>` and distributed as part of ROCm Compute Profiler. .. include:: ./includes/valu-arithmetic-instruction-mix.rst