Thank you for contributing! We welcome bug fixes, documentation improvements, and APU platform telemetry profiles (especially Phoenix/Hawk Point captures).
Our first duty is to not lie about what we measure.
- Always report NPU activity as submission-counter deltas / active hardware contexts, never as a utilization percentage.
- If a metrics source is unavailable, degrade gracefully and notify the user instead of displaying guess-work.
- Do not let documentation imply the hardware gives a signal it does not.
To maintain clear provenance and code-hygiene standards:
- If your pull request or commit was generated or assisted by an LLM (e.g., Gemini, Claude, ChatGPT, etc.), please explicitly state so in the PR description.
To run the unit tests, install the dev dependencies and invoke pytest:
pip install -e '.[dev]'
pytest tests/The dev extra pulls in the docs tooling (PyYAML, used by
tools/build_experiments_index.py) and the exporter (prometheus_client) so
that every test module is collectable. A bare pip install -e . is enough to
run xdna-top itself, but will skip those test modules.
We look forward to your contributions!