Contributing

Contributing#

To report issues and submit pull requests, visit the GitHub repository.

Set up a development environment#

To clone the repository and navigate into the directory:

git clone https://github.com/AMDResearch/intellikit.git
cd intellikit

Each tool within IntelliKit is an independent Python package. You can install the packages you want to work on in editable mode:

pip install -e ./metrix
pip install -e ./linex
pip install -e ./kerncap[dev]
# ...any subset

There is no metapackage at the root level of the repository. You must install each package individually.

Running tests#

Each package has its own test suite:

# Metrix
python3 -m pytest metrix/tests/ -v

# Kerncap unit tests (no GPU required)
PYTHONPATH=kerncap pytest kerncap/tests/unit/ -v

# Kerncap integration tests (requires ROCm + AMD GPU)
PYTHONPATH=kerncap pytest kerncap/tests/integration/ -v

Project structure#

The IntelliKit repository is organized as follows.

intellikit/
├── accordo/        Kernel validation
├── kerncap/        Kernel extraction and isolation
├── linex/          Source-line GPU profiling
├── metrix/         Human-readable GPU metrics
├── nexus/          HSA packet source extraction
├── rocm_mcp/       ROCm MCP servers
├── uprof_mcp/      AMD uProf MCP server
├── install/        Install scripts (tools + skills)
└── docs/           This documentation site

Report bugs and suggest features#

Report issues or share your suggestions on the IntelliKit issue tracker.

IntelliKit license#

This project is licensed under the MIT License.