Skip to content

Adding docs to the main#132

Open
mattwill-amd wants to merge 51 commits into
mainfrom
docs/0.1.0
Open

Adding docs to the main#132
mattwill-amd wants to merge 51 commits into
mainfrom
docs/0.1.0

Conversation

@mattwill-amd

Copy link
Copy Markdown

Adding docs updates to Main

yugang-amd and others added 10 commits July 3, 2026 09:36
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
@mattwill-amd

Copy link
Copy Markdown
Author

@mawad-amd Do we have any docs for release notes and compatibility matrix? This is required for publication

Comment thread docs/conf.py Outdated
Comment thread docs/getting-started/installation.md Outdated
Comment thread docs/getting-started/installation.md Outdated
Comment thread docs/tools/kerncap.md Outdated
Comment thread docs/tools/accordo.md Outdated
Comment thread docs/what-is-intellikit.md Outdated
@mawad-amd

Copy link
Copy Markdown
Member

@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?

@mawad-amd

Copy link
Copy Markdown
Member

@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 coleramos425 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

yugang-amd and others added 11 commits July 8, 2026 12:15
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants