Skip to content

Commit 46cf7d8

Browse files
committed
Fix command typo in README.md for reproducer generation
1 parent fa06e41 commit 46cf7d8

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

README.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,30 @@
3333

3434
## 🚀 Quick Start
3535

36-
### 1. Generate Traces
36+
### 1. Installation
37+
38+
**Four options to install:**
39+
```bash
40+
# install nightly version
41+
pip install -U --pre tritonparse
42+
# install stable version
43+
pip install tritonparse
44+
# install from source
45+
git clone https://github.com/meta-pytorch/tritonparse.git
46+
cd tritonparse
47+
pip install -e .
48+
# pip install the latest version from github
49+
pip install git+https://github.com/meta-pytorch/tritonparse.git
50+
```
51+
52+
**Prerequisites:** Python ≥ 3.10, Triton ≥ 3.4.0, GPU required (NVIDIA/AMD)
53+
54+
TritonParse relies on new features in Triton. If you're using nightly PyTorch, Triton is already included. Otherwise, install the latest Triton:
55+
```bash
56+
pip install triton
57+
```
58+
59+
### 2. Generate Traces
3760

3861
```python
3962
import tritonparse.structured_logging
@@ -68,19 +91,19 @@ tritonparse.utils.unified_parse("./logs/", out="./parsed_output")
6891
```
6992
</details>
7093

71-
### 2. Visualize Results
94+
### 3. Visualize Results
7295

7396
**Visit [https://meta-pytorch.org/tritonparse/](https://meta-pytorch.org/tritonparse/?json_url=https://meta-pytorch.org/tritonparse/dedicated_log_triton_trace_findhao__mapped.ndjson.gz)** and open your local trace files (.ndjson.gz format).
7497

7598
> **🔒 Privacy Note**: Your trace files are processed entirely in your browser - nothing is uploaded to any server!
7699
77-
### 3. Generate Reproducers (Optional)
100+
### 4. Generate Reproducers (Optional)
78101

79102
Extract any kernel into a standalone, executable Python script for debugging or testing:
80103

81104
```bash
82105
# Generate reproducer from first launch event
83-
tritonparse reproduce ./parsed_output/trace.ndjson.gz --line 2 --out-dir repro_output
106+
tritonparseoss reproduce ./parsed_output/trace.ndjson.gz --line 2 --out-dir repro_output
84107

85108
# Run the generated reproducer
86109
cd repro_output/<kernel_name>/
@@ -109,30 +132,6 @@ result = reproduce(
109132

110133
</details>
111134

112-
## 🛠️ Installation
113-
114-
**For basic usage (trace generation):**
115-
Four options:
116-
```bash
117-
# install nightly version
118-
pip install -U --pre tritonparse
119-
# install stable version
120-
pip install tritonparse
121-
# install from source
122-
git clone https://github.com/meta-pytorch/tritonparse.git
123-
cd tritonparse
124-
pip install -e .
125-
# pip install the latest version from github
126-
pip install git+https://github.com/meta-pytorch/tritonparse.git
127-
```
128-
129-
**Prerequisites:** Python ≥ 3.10, Triton ≥ 3.4.0, GPU required (NVIDIA/AMD)
130-
131-
TritonParse relies on new features in Triton. Please install the latest version of Triton:
132-
```bash
133-
pip install triton
134-
```
135-
136135
## 📚 Complete Documentation
137136

138137
| 📖 Guide | Description |

0 commit comments

Comments
 (0)