composable_kernel icon indicating copy to clipboard operation
composable_kernel copied to clipboard

docs: update ckProfiler readme with selective building option

Open AviralGoelAMD opened this issue 1 month ago • 0 comments

This pull request improves the documentation for building specific profilers in the profiler/README.md. The main change is the addition of instructions on how to filter which operations to compile using CMake options.

Documentation improvements:

  • Added a new section explaining how to use the CK_PROFILER_OP_FILTER and CK_PROFILER_INSTANCE_FILTER CMake options with regex patterns to selectively build profiler operations, including example commands for common use cases.

Checklist

Please put an x into the boxes that apply. You can also fill these out after creating the PR. If you're not sure, please don't hesitate to ask.

  • [x] I have added tests relevant to the introduced functionality, and the unit tests are passing locally
  • [x] I have added the test to REGRESSION_TESTS list defined at the top of CMakeLists.txt in tests/CMakeLists.txt, IF the test takes more than 30 seconds to run.
  • [x] I have added inline documentation which enables the maintainers with understanding the motivation
  • [x] I have removed the stale documentation which is no longer relevant after this pull request
  • [x] (If this change is user-facing) I have added release notes which provide the end users with a brief summary of the improvement from this pull request
  • [x] I have run clang-format on all changed files
  • [x] Any dependent changes have been merged

Discussion

If this is a relatively large or complex change, feel free to start a discussion by explaining why you chose the solution you did and what alternatives you considered

AviralGoelAMD avatar Nov 01 '25 22:11 AviralGoelAMD