Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (32 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

39 lines (32 loc) · 1.21 KB
Raw

Contributing to Triton-Viz

Quick Start

# Clone repo
git clone https://github.com/Deep-Learning-Profiling-Tools/triton-viz.git
cd triton-viz

# Setup dev environment and install dependencies
uv sync --extra test  # append "--extra nki" if developing NKI functionality
pre-commit install

# (code up the PR)

# Test
uv run pytest tests/ -m ""      # run all tests
npm run build:frontend           # build the web UI (if working on the visualizer)
npm run test:frontend            # test the web UI (if working on the visualizer)

Project Structure

frontend/             # TypeScript web UI source code
examples/             # Entry points for new users to try out triton-viz functionality
docs/                 # triton-viz website
triton_viz/
  core/frontend/      # DSL operation adapters and runtime patching
  core/simulation/    # NKI simulation runtimes
  clients/            # Visualizer, profiler, and sanitizer clients
  visualizer/         # Python interface for the visualizer
  utils/              # Miscellaneous utility functions
tests/
  unit/               # Unit tests
  end_to_end/         # End-to-end tests
  frontend/           # Web UI tests
  nki/                # NKI-related tests