Adding docs to the main#132
Conversation
Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Co-authored-by: Yiannis Papadopoulos <102817138+ypapadop-amd@users.noreply.github.com>
RTD setup for IntelliKit docs
|
@mawad-amd Do we have any docs for release notes and compatibility matrix? This is required for publication |
Hi Matt, we haven't published a release yet. If you would like to add an empty release notes section, please do and we will maintain it once we release. We run on any MI3XX GPUs. @coleramos425, do you have any compatibility requirement for ROCm/vLLM/SGLang you want to add here? |
|
@mattwill-amd if we are going to keep hosting this on https://amdresearch.github.io/intellikit/ could you please also update the https://github.com/AMDResearch/intellikit/blob/main/.github/workflows/docs.yml file? |
coleramos425
left a comment
There was a problem hiding this comment.
coleramos425, do you have any compatibility requirement for ROCm/vLLM/SGLang you want to add here?
LGTM. The only ambiguity that I found where we might want to clarify is below. Other than that, the current requirements are sufficient
|
|
||
| ### System dependencies for Accordo and Nexus | ||
|
|
||
| Accordo and Nexus use C++ components from KernelDB, which are compiled during `pip install`. |
There was a problem hiding this comment.
We may want to add a sentence or small comment here about how these requirements optionally apply to Kerncap. Something like "Additionally, for an improved experience in Kerncap".
The full explanation might be overkill but could be helpful for your context. In the event the user is working with a framework-generated HIP kernel (i.e. Kokkos) where the __global__ qualifier (that we use for source file discovery) lives in framework headers rather than user code, DWARF info (i.e. libdwarf-dev) is often a more reliable way to extract all source files that contributed to the translation unit in question.
It's not required (we have a fallback to a grep-based search), but we've had better luck isolating these framework-generated HIP kernels when debug DWARF is present.
For more a more detailed explanation see section 4.3.1 of Kerncap paper.
Update per internal review
Co-authored-by: pmoutsias-amd <peter.moutsias@amd.com>
Co-authored-by: pmoutsias-amd <peter.moutsias@amd.com>
Co-authored-by: pmoutsias-amd <peter.moutsias@amd.com>
Co-authored-by: pmoutsias-amd <peter.moutsias@amd.com>
Co-authored-by: pmoutsias-amd <peter.moutsias@amd.com>
Co-authored-by: pmoutsias-amd <peter.moutsias@amd.com>
Adding docs updates to Main