kokkos-tools icon indicating copy to clipboard operation
kokkos-tools copied to clipboard

User Documentation of Kokkos Tools TPL Connectors

Open vlkale opened this issue 8 months ago • 9 comments

This issue aims to lay groundwork on the centralized documentation of Kokkos Tools vendor aTPL connectors, i.e., advanced TPL connectors.

Documentation of aTPLs is different from the documentation for basic Kokkos Tools in-house tooling libraries that are being documented. These are well-established external libaries that are maintained by third parties developing their own connectors. They don't operate on Kokkos project timelines. They do need an centralized/common location to come to for providing users information on how to use their tooling library within the Kokkos ecosystem.

Of immediate importance: ScoreP needs to be part a third-party library subsection in the Wiki, alongside timemory, given its importance of profiling+tracing in HPC. Though it is not in the category of so-called 'sophisticated tools' with intelligent analysis and/or tuning, e.g., Apex, it does provide advanced capabilities needed for tracing from a third-party library. It is also not as heavily used as nvtx-connector. It doesn't need to be in the top-level README.md of Kokkos Tools. At the same time, there are a number of Kokkos users using it.

In time, this documentation could propagate up the Kokkos Tools Wiki and the kokkos.org webpage, perhaps as a blog post or within tools documentation itself.

vlkale avatar Jun 04 '24 01:06 vlkale