tilelang-devkit

Developer tooling for TileLang.

The package currently ships lower_trace, a pass-by-pass IR tracing tool built on TVM PassInstrument and TileLang's compilation instrumentation interfaces. It records raw before/after IR, prints terminal diffs, and generates a self-contained HTML report without patching TVM globals.

Install

pip install tilelang-devkit

The package has no hard dependencies. Install it into the Python environment that already provides the compatible TileLang/TVM build you want to inspect. Python 3.10 or newer is required.

For development:

git clone https://github.com/easy-tilelang/tilelang-devkit.git
cd tilelang-devkit
pip install -e '.[dev]'

Trace a complete TileLang compilation

Compatible TileLang versions discover the package through the tilelang.instrumentation_tools entry point:

TL_LOWER_TRACE=both python kernel.py

Supported values are terminal, html, and both. The truthy shorthand values 1, true, yes, and on select html; 0, false, no, and off disable tracing.

Reports are written below ./tmp/lower_trace_dir/<script-name>/ by default. Select another base directory with:

TL_LOWER_TRACE=both \
TL_LOWER_TRACE_DIR="$PWD/tmp/lower_trace_dir" \
python kernel.py

The latest report is available as <script-name>/report.html; immutable run data lives under <script-name>/.run_records/run_<timestamp>_<pid>_<id>/. If TileLang serves a cached compilation result, no lowering passes execute and there is nothing new to trace; disable the TileLang kernel cache when you need a fresh compilation trace.

Tracing can also be controlled from Python:

import tilelang_devkit.lower_trace as lt

lt.enable(mode="both", trace_dir="./traces")
# tilelang.compile(...)
lt.disable()

The v0.1 context-manager API remains available and selects terminal mode:

from tilelang_devkit.lower_trace import trace

with trace(trace_dir="./traces"):
    # compile a TileLang kernel
    ...

Trace selected TVM passes

Apply and compare a fixed pass chain:

import tilelang_devkit.lower_trace as lt

results = lt.lower_trace(
    mod,
    [("Simplify", simplify_pass)],
    mode="both",
    html_path="lower-trace.html",
)

Or instrument an existing PassContext:

from tvm.ir.transform import PassContext
import tilelang_devkit.lower_trace as lt

instrument = lt.create_pass_instrument(mode="html", trace_dir="./traces")
with PassContext(instruments=[instrument]):
    with lt.phase("optimization"):
        # run TVM passes
        ...
instrument.finish()

The full manual covers the HTML viewer, raw IR files, host/device source output, and the edit-and-recompile workflow.

Public API

• lower_trace(...): run and compare selected passes.
• create_pass_instrument(...): create a standalone TVM pass instrument.
• phase(name): label records produced by the standalone instrument.
• enable(...), disable(), reset(): control future TileLang sessions.
• trace(trace_dir=None): compatibility context manager.
• LowerRecord: one pass or code-generation record.

Importing tilelang_devkit.lower_trace does not eagerly import TileLang. The TileLang-specific adapter is loaded only when its API or plugin entry point is used.

Releasing (maintainers)

Versions come from Git tags through setuptools-scm; do not edit _version.py. Use v followed by a Python package version; prerelease versions are also supported. Replace <version> below with the actual version number, then run from a clean checkout of the intended release commit:

git tag -a "v<version>" -m "Release <version>"
git push origin "v<version>"

Pushing the tag starts Publish to PyPI. It calls the reusable test workflow on the tagged commit and builds the sdist and wheel in parallel. The build job builds both distributions directly from the Git checkout to retain commit metadata in the wheel. It checks distribution metadata, installs the wheel in an isolated environment, verifies its version, commit metadata, plugin entry point and py.typed, and runs framework-neutral smoke/import tests. Publishing requires both the build checks and the complete test suite (including TileLang integration) to pass. The publish job uploads the same validated artifacts without rebuilding them. Branch pushes and pull requests run tests independently; tag pushes do not start a second standalone test workflow.

Publishing uses PyPI Trusted Publishing with this repository, .github/workflows/workflow.yml, and the GitHub environment pypi. Keep the workflow filename and environment name aligned with the PyPI publisher configuration. Only the publish job receives OIDC token permission.

Inspect Actions → Publish to PyPI for the failing job and logs. A failed or cancelled test/build prevents publishing. For a transient failure before any upload, rerun the failed jobs. If an upload failed, check which files reached PyPI before retrying: an already uploaded file cannot be overwritten, and a partial upload may require manual recovery. For a code or packaging fix, create a new version and tag; do not move a published tag or reuse its version. On each release, confirm tests finished before the upload and verify the resulting PyPI version page. This workflow does not create a GitHub Release.

License

Apache-2.0