Skip to content

Commit c57a3ac

Browse files
FindHaofacebook-github-bot
authored andcommitted
Initialize CHANGELOG and update version to 0.1.0 for TritonParse (#40)
Summary: - Created a new CHANGELOG.md file to document notable changes and adhere to the Keep a Changelog format. - Updated project version to 0.1.0 in pyproject.toml, website/package.json, and website/package-lock.json to reflect the initial public release. - Added detailed entries in the changelog for features such as an interactive web interface, structured logging backend, source-to-source mapping, kernel launch tracing, and more. These changes establish a foundation for tracking project updates and enhance the overall documentation for users and contributors. Pull Request resolved: #40 Reviewed By: Sibylau Differential Revision: D78666960 Pulled By: FindHao fbshipit-source-id: 55163749f6951242a21829253d3746ad5eae873f
1 parent aa7af5f commit c57a3ac

File tree

4 files changed

+78
-67
lines changed

4 files changed

+78
-67
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.0] - 2024-07-31
9+
10+
This is the initial public release of TritonParse.
11+
12+
### Added
13+
14+
- **Interactive Web Interface**: A rich, client-side web UI for exploring, comparing, and understanding Triton IRs. Features side-by-side code views, synchronized highlighting, and detailed metadata panels.
15+
- **Structured Logging Backend**: A powerful Python backend to capture detailed information from the Triton compiler and runtime, including IRs (TTIR, TTGIR, PTX, AMDGCN), metadata, timings, and Python source code, and outputs it as structured NDJSON logs.
16+
- **Source-to-Source Mapping**: Automatic generation of bidirectional mappings between Python code and all intermediate representations (IRs), allowing you to trace a line of Python code all the way down to the generated assembly and back.
17+
- **Kernel Launch Tracing**: Capability to trace each kernel launch, capturing the grid dimensions, kernel arguments (with detailed tensor information), and other runtime metadata.
18+
- **Flexible Log Parsing CLI**: A command-line interface (`run.py`) to parse logs from local files or directories, and from single or multiple ranks in a distributed training job.
19+
- **Prerequisites Documentation**: Clear requirements for Python (>=3.10), PyTorch, and Triton (>3.3.1, compiled from source).
20+
- **Getting Started Guide**: A step-by-step workflow for generating, parsing, and visualizing traces.
21+
- **Configuration via Environment Variables**: Support for `TRITON_TRACE`, `TRITON_TRACE_LAUNCH`, `TRITONPARSE_KERNEL_ALLOWLIST`, and `TRITON_TRACE_GZIP`.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "tritonparse"
7-
version = "0.0.5"
7+
version = "0.1.0"
88
dependencies = [
99
"triton",
1010
]

website/package-lock.json

Lines changed: 55 additions & 65 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

website/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "tritonparse-website",
33
"private": true,
4-
"version": "0.0.5",
4+
"version": "0.1.0",
55
"type": "module",
66
"scripts": {
77
"dev": "vite",

0 commit comments

Comments
 (0)