TileOPs-Metax/docs/perf
Zheng QiHang 2bcb708413
[Doc][Trace] Doc-ready docstrings + in-kernel timeline tutorial (#1640)
## What

Makes the `tileops.trace` module documentation-ready and adds a usage
tutorial,
so the trace tool renders cleanly on the docs site (mkdocstrings +
Material).

- **Docstrings: Sphinx roles → plain code spans.** Across the whole
`tileops/trace/` package (`__init__`, `api`, `decode`, `markers`,
`passes`,
`record`, `state`, `ui`), replace `:func:` / `:class:` / `:mod:` /
`:data:`
  cross-reference roles with double-backtick code spans. The project is
Google-docstring-only; mkdocstrings does not resolve Sphinx roles, so
they
  rendered as literal `:func:`...`` text on the site.
- **`ui.py` timeline legend fix.** The horizontal legend overlapped the
x-axis
  title. Give the x-axis title a `standoff`, anchor the legend below it
  (`y: -0.30`, `yanchor: top`), and grow the bottom margin (120 → 170).
- **New tutorial: `docs/perf/trace-timeline.md`.** End-to-end
walkthrough —
  write a traced warp-specialized GEMM, run it, enable tracing, read the
timeline. Each code block uses Material code annotations (the `+`
markers)
  linked to the auto-generated API reference.
- **`docs/perf/README.md`**: add a "Tools & Guides" entry pointing at
the tutorial.

## Why

The trace tool shipped in #1638 with no rendered API docs or guide; this
makes
its public surface (`tileops.trace.api`) render correctly and gives
users a
single walkthrough.

## Notes

- No behavior change: docstring text and one Plotly layout dict only.
- The site-side wiring (mkdocstrings page, nav, embedded timeline) is a
separate
  PR against `tile-ai/TileOPs.github.io`.

Closes #1639
2026-06-30 13:27:07 +08:00
..
README.md [Doc][Trace] Doc-ready docstrings + in-kernel timeline tutorial (#1640) 2026-06-30 13:27:07 +08:00
elementwise-evidence.md [Enhancement][Elementwise] Deploy strategy-aware npt defaults for fp16/bf16 (#562) 2026-03-19 18:44:46 +08:00
elementwise.md [Perf][Elementwise] Generalize kernel caching and autotune to all kernel families (#560) 2026-03-18 20:11:41 +08:00
trace-timeline.md [Doc][Trace] Doc-ready docstrings + in-kernel timeline tutorial (#1640) 2026-06-30 13:27:07 +08:00

README.md

Performance Guides

Empirical performance lessons per op category. Each category has:

  • Checklist — heuristic rules for audit (lightweight, always load)
  • Evidence — measured data and reasoning (load on demand)

Test Environment

All conclusions are scoped to this configuration. Re-validate when any component changes.

Component Value
GPU NVIDIA H200 (HBM3e, 4.8 TB/s peak, SM_90a)
Driver / CUDA 575.57.08 / 12.8
PyTorch 2.9.1+cu128
TileLang 0.1.9
Profiler CUPTI (primary); CUDA event+median fallback when CUPTI singleton unavailable

Index

Category Checklist Evidence
Elementwise elementwise.md elementwise-evidence.md

Tools & Guides

Guide What it covers
trace-timeline.md In-kernel timeline tracer: annotate, build, run, and read