From 6c49f3a0aea63edd7148a717c682dcff42b3d627 Mon Sep 17 00:00:00 2001 From: xuchen-amd Date: Thu, 3 Oct 2024 13:17:43 -0400 Subject: [PATCH] Rebranding of top level md files. --- CONTRIBUTING.md | 18 +++++++++--------- README.md | 8 ++++---- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f18ea2ca..c34472da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ ## How to fork from us -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 `amd-staging` branch in your private repository. +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 `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/ROCm/omniperf.git -git checkout amd-staging +git remote add mainline https://github.com/ROCm/rocprofiler-compute.git +git checkout dev ``` As always in git, start a new branch with @@ -17,23 +17,23 @@ git checkout -b topic- and apply your changes there. -## How to contribute to Omniperf +## How to contribute to ROCm Compute Profiler ### Did you find a bug? -- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/ROCm/omniperf/issues). +- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/ROCm/rocprofiler-compute/issues). -- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ROCm/omniperf/issues/new). +- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/ROCm/rocprofiler-compute/issues/new). ### Did you write a patch that fixes a bug? -- Open a new GitHub [pull request](https://github.com/ROCm/omniperf/compare) with the patch. +- Open a new GitHub [pull request](https://github.com/ROCm/rocprofiler-compute/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 `amd-staging` branch of the Omniperf GitHub repository. +- Ensure the PR is based on the `dev` branch of the ROCm Compute Profiler 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](LICENSE): +- ROCm Compute Profiler 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/rocprofiler-compute/blob/main/LICENSE): > (a) The contribution was created in whole or in part by me and I diff --git a/README.md b/README.md index 7d82c854..cea4bf7b 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ [![Docs](https://github.com/ROCm/rocprofiler-compute/actions/workflows/docs.yml/badge.svg)](https://rocm.github.io/rocprofiler-compute/) [![DOI](https://zenodo.org/badge/561919887.svg)](https://zenodo.org/badge/latestdoi/561919887) -# rocprof-compute +# ROCm Compute Profiler ## General -rocprof-compute is a system performance profiling tool for machine +ROCm Compute Profiler is a system performance profiling tool for machine learning/HPC workloads running on AMD MI GPUs. The tool presently targets usage on MI100, MI200, and MI300 accelerators. @@ -16,7 +16,7 @@ targets usage on MI100, MI200, and MI300 accelerators. workload profiling and analysis, please refer to the online [documentation](https://rocm.docs.amd.com/projects/rocprofiler-compute/en/latest/). -* rocprof-compute is an AMD open source research project and is not supported +* ROCm Compute Profiler is an AMD open source research project and is not supported as part of the ROCm software stack. We welcome contributions and feedback from the community. Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for additional details on our @@ -26,7 +26,7 @@ contribution process. ## Development -rocprof-compute follows a +ROCm Compute Profiler follows a [main-dev](https://nvie.com/posts/a-successful-git-branching-model/) branching model. As a result, our latest stable release is shipped from the `amd-mainline` branch, while new features are developed in our