Kokkos Tools provides a collection of lightweight profiling and debugging utilities that interface with instrumentation hooks in the Kokkos runtime. Unlike NVTX or ROCTx, Kokkos Tools emphasize Kokkos-centric analysis. Profiling hooks are included in Kokkos executables by default, so applications can load tools at runtime without recompilation.
Kokkos Tools is part of the Kokkos C++ Performance Portability Programming Ecosystem. and meets the maturing life-cycle stage.
For complete documentation—including build instructions, usage, tool descriptions, tutorials, and contributing guidelines—see the Kokkos Tools Wiki.
Development versions are available from the develop branch. Tagged releases appear on the GitHub releases page.
git clone --branch develop https://github.com/kokkos/kokkos-tools.gitBuilding Kokkos Tools requires a C++20 compatible compiler or later. CMake is the recommended build system:
cmake -S . -B build -DCMAKE_INSTALL_PREFIX=${YOUR_KOKKOS_TOOLS_INSTALL_DIR}
cmake --build build
cmake --install buildSee the wiki for Makefile builds, backend-specific connectors, and runtime configuration (KOKKOS_TOOLS_LIBS, --kokkos-tools-libs).
For questions, use Slack: https://kokkosteam.slack.com or open a GitHub issue.
As a maturing subproject in the Kokkos Ecosystem, Kokkos Tools' testing regime is not as rigorous as we'd like it to be. For details on the testing status of the 5.2 release please see GitHub issue 338.
See the wiki contributing guidance and Submitting a Pull Request.
