Skip to content

Commit

Permalink
Rename CMake file and rename paths from omniperf to rocprofcompute.
Browse files Browse the repository at this point in the history
  • Loading branch information
xuchen-amd committed Oct 9, 2024
1 parent 05df82d commit db7f302
Show file tree
Hide file tree
Showing 9 changed files with 32 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ body:
id: logs
attributes:
label: Relevant log output
description: Please copy and paste rocprof-Compute's `log.txt` file. This will be automatically formatted into code, so no need for backticks.
description: Please copy and paste rocprof-compute's `log.txt` file. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/rhel-8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
run: |
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/opt/rocprof-compute -DPYTEST_NUMPROCS=4 ..
cmake -DCMAKE_INSTALL_PREFIX=/opt/rocprofiler-compute -DPYTEST_NUMPROCS=4 ..
make install
- name: CTest- Analyze Commands
run: |
Expand Down
2 changes: 1 addition & 1 deletion AUTHORS
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This is the list of rocprof-compute's significant contributors.
# This is the list of ROCm Compute Profiler's significant contributors.
#
# This does not necessarily list everyone who has contributed code,
# especially since many employees of one corporation may be contributing.
Expand Down
21 changes: 12 additions & 9 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,14 @@ string(REGEX REPLACE "([0-9]+)\.([0-9]+)\.([0-9]+)(.*)" "\\1.\\2.\\3" OMNIPERF_V
# string(REGEX REPLACE "^\\." "" OMNIPERF_VERSION_TWEAK "${OMNIPERF_VERSION_TWEAK}")

project(
omniperf
rocprofcompute
VERSION ${OMNIPERF_VERSION}
LANGUAGES C
DESCRIPTION "OmniPerf"
HOMEPAGE_URL "https://github.com/ROCm/omniperf")
DESCRIPTION "A system performance profiling tool for machine learning/HPC workloads running on AMD MI GPUs"
HOMEPAGE_URL "https://github.com/ROCm/rocprofiler-compute")

set(PACKAGE_NAME "rocprof-compute")
set(PACKAGE_NAME_UNDERSCORE "rocprof_compute")

include(ExternalProject)
include(GNUInstallDirs)
Expand Down Expand Up @@ -276,7 +279,7 @@ add_test(

# top-level omniperf utility
install(
PROGRAMS src/omniperf
PROGRAMS src/${PACKAGE_NAME}
DESTINATION ${CMAKE_INSTALL_LIBEXECDIR}/${PROJECT_NAME}
COMPONENT main)
# python dependency requirements
Expand Down Expand Up @@ -348,7 +351,7 @@ install(
CODE "execute_process(
COMMAND bash -c \"set -e
cd \$ENV{DESTDIR}\${CMAKE_INSTALL_PREFIX}
ln -sf ../${CMAKE_INSTALL_LIBEXECDIR}/${PROJECT_NAME}/omniperf ${CMAKE_INSTALL_BINDIR}/omniperf
ln -sf ../${CMAKE_INSTALL_LIBEXECDIR}/${PROJECT_NAME}/${PACKAGE_NAME} ${CMAKE_INSTALL_BINDIR}/${PACKAGE_NAME}
\")"
COMPONENT main)

Expand All @@ -361,7 +364,7 @@ add_custom_target(
COMMAND
${PROJECT_SOURCE_DIR}/utils/update_license.py --source ${PROJECT_SOURCE_DIR}
--license ${PROJECT_SOURCE_DIR}/LICENSE --file
"src/omniperf,cmake/Dockerfile,cmake/rocm_install.sh,docker/docker-entrypoint.sh,src/rocprof_compute_analyze/convertor/mongodb/convert"
"src/${PACKAGE_NAME},cmake/Dockerfile,cmake/rocm_install.sh,docker/docker-entrypoint.sh,src/rocprof_compute_analyze/convertor/mongodb/convert"
)

# TEST collateral
Expand Down Expand Up @@ -396,9 +399,9 @@ set(CPACK_GENERATOR
set(CPACK_PACKAGE_NAME
"${PROJECT_NAME}"
CACHE STRING "")
set(CPACK_PACKAGE_CONTACT "https://github.com/ROCm/omniperf")
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Omniperf: tool for GPU performance profiling")
set(CPACK_RPM_PACKAGE_DESCRIPTION "Omniperf is a performance analysis tool for profiling
set(CPACK_PACKAGE_CONTACT "https://github.com/ROCm/rocprofiler-compute")
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "ROCm Compute Profiler: tool for GPU performance profiling")
set(CPACK_RPM_PACKAGE_DESCRIPTION "ROCm Compute Profiler is a performance analysis tool for profiling
machine learning/HPC workloads running on AMD GPUs.")
set(CPACK_PACKAGE_VENDOR "Advanced Micro Devices, Inc.")

Expand Down
10 changes: 5 additions & 5 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Maintainers Guide to Omniperf
# Maintainers Guide to ROCm Compute Profiler

## Publishing a release

Before publishing a new Omniperf release, please review this checklist to ensure all prerequisites are met:
Before publishing a new ROCm Compute Profiler release, please review this checklist to ensure all prerequisites are met:

1) **Ensure [VERSION](VERSION) file is updated** to reflect your desired release version.
2) **Sync `amd-mainline` with `amd-staging`**. A rebase may be required to pull all the desired patches from the development branch to our stable mainline. Click [here](https://github.com/ROCm/omniperf/compare/amd-mainline...amd-staging) to begin that process.
2) **Sync `amd-mainline` with `amd-staging`**. A rebase may be required to pull all the desired patches from the development branch to our stable mainline. Click [here](https://github.com/ROCm/rocprofiler-compute/compare/amd-mainline...amd-staging) to begin that process.
3) **Update [CHANGES](CHANGES)** to reflect all major modifications to the codebase since the last release. When modifying [CHANGES](CHANGES) please ensure formatting is consistent with the rest of the ROCm software stack. See [this template](https://github.com/ROCm/hipTensor/blob/develop/CHANGELOG.md) for reference.
4) **Confirm all CI tests are passing**. You can easily confirm this by peeking the passing status of all GitHub continuous integration tests.
5) **Create a tag from `amd-mainline`**. More information on tagging can be found at [Git Docs - Tagging](https://git-scm.com/book/en/v2/Git-Basics-Tagging).

> [!NOTE]
Note: A successful tag should trigger the [packaging action](.github/workflows/packaging.yml) which will produce a tarball artifact. **This artifact needs to be included as an asset in your release**. Please find that the [packaging action](.github/workflows/packaging.yml) will automatically create a draft release with your tarball attached.

Once you've completed the above checklist, you are ready to publish your release. Please ensure you follow formatting from [past Omniperf releases](https://github.com/ROCm/omniperf/releases) for consistency. Some important aspects of our release formatting include:
Once you've completed the above checklist, you are ready to publish your release. Please ensure you follow formatting from [past ROCm Compute Profiler releases](https://github.com/ROCm/rocprofiler-compute/releases) for consistency. Some important aspects of our release formatting include:

- Date of release is included in "Release Title".
- Updates are called out in "Release Description". Updates should mirror those listed in [CHANGES](CHANGES).
Expand All @@ -24,6 +24,6 @@ Once you've completed the above checklist, you are ready to publish your release

If you are preparing for a new ROCm release, note that the [rocm-ci](https://github.com/rocm-ci) bot managed by DevOps will be triggering a tag automatically. This tag will follow the format `rocm-X.X.X`.

Traditionally, we will bump the Omniperf [VERSION](VERSION) with a new ROCm release. When we bump the version and reach the prerequisite step (5) above, try tagging with `vX.X.X` to validate the release tarball generated by the [packaging action](.github/workflows/packaging.yml).
Traditionally, we will bump the ROCm Compute Profiler [VERSION](VERSION) with a new ROCm release. When we bump the version and reach the prerequisite step (5) above, try tagging with `vX.X.X` to validate the release tarball generated by the [packaging action](.github/workflows/packaging.yml).

In addition to the prerequisites mentioned above, please make sure that all changes have been merged from `amd-staging` -> `release/rocm-rel-X.X.X` to ensure that the "rocm-ci" bot will capture all your changes. It is easiest to file a single pull request ahead of the ROCm release.
4 changes: 2 additions & 2 deletions grafana/plugins/omniperf_plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Omniperf Data Source Plugin
# ROCm Compute Profiler Data Source Plugin

This plugin allows users of Omniperf to connect their MongoDB database to for visualization in Grafana
This plugin allows users of ROCm Compute Profiler to connect their MongoDB database to for visualization in Grafana

## Info

Expand Down
2 changes: 1 addition & 1 deletion grafana/plugins/omniperf_plugin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,5 @@
"mongodb": "^4.12.1",
"statman-stopwatch": "^2.7.0"
},
"_comments": "Dependencies are not included as part of Omniperf. It's the user's responsibility to accept any licensing implications before building the project."
"_comments": "Dependencies are not included as part of ROCm Compute Profiler. It's the user's responsibility to accept any licensing implications before building the project."
}
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ exclude = '''
| external
| .pytest_cache
| build
| build-omniperf
| build-rocprof_compute
)/
)
'''
Expand Down
16 changes: 8 additions & 8 deletions utils/build.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

pyinstaller src/omniperf.py \
--name "omniperf" \
pyinstaller src/rocprofiler-compute.py \
--name "rocprofiler-compute" \
--add-data "src/perfmon_pub/*:perfmon_pub" \
--add-data "src/utils/*:utils" \
--add-data "src/soc_params/*.csv:soc_params" \
Expand Down Expand Up @@ -53,14 +53,14 @@ echo "(build.sh) Loading dash_svg"
# Take care of dash-svg module that isn't detected by PyInstaller
dash_info=$(pip3 show dash_svg)
dash_loc=$(sed -n '8p' <<<"$dash_info")
cp -r ${dash_loc:10}/dash_svg "$distpath"/omniperf/
cp -r ${dash_loc:10}/dash_svg "$distpath"/rocprofiler-compute/

echo "(build.sh) Fixing flattened directories"
#TODO: Copy orig file structure from over to flattened packaged version
rm -rf "$distpath"/omniperf/rocprof_compute_analyze/
cp -r src/rocprof_compute_analyze/ "$distpath"/omniperf/
rm -rf "$distpath"/rocprofiler-compute/rocprof_compute_analyze/
cp -r src/rocprof_compute_analyze/ "$distpath"/rocprofiler-compute/

rm -rf "$distpath"/omniperf/perfmon_pub/
cp -r src/perfmon_pub/ "$distpath"/omniperf/
rm -rf "$distpath"/rocprofiler-compute/perfmon_pub/
cp -r src/perfmon_pub/ "$distpath"/rocprofiler-compute/

rm -rf "$distpath"/omniperf/perfmon/
rm -rf "$distpath"/rocprofiler-compute/perfmon/

0 comments on commit db7f302

Please sign in to comment.