Skip to content

Commit 49ac457

Browse files
[DOCS] show user install instructions in addition to install from src (#253)
1 parent 3cb0ab9 commit 49ac457

File tree

2 files changed

+15
-17
lines changed

2 files changed

+15
-17
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,13 @@ The best part about this tool is that while it does focus on visualizing GPU ope
5555

5656
### Installation of Triton-Viz
5757

58-
Clone the repository to your local machine:
58+
Most users can install directly from GitHub:
59+
60+
```sh
61+
pip install git+https://github.com/Deep-Learning-Profiling-Tools/triton-viz.git
62+
```
63+
64+
If you want to run examples from this repo, contribute, or build the frontend, install from source instead:
5965

6066
```sh
6167
git clone https://github.com/Deep-Learning-Profiling-Tools/triton-viz.git
@@ -78,7 +84,7 @@ npm run build:frontend
7884

7985
### Optional: Enable NKI Support
8086

81-
If you want to exercise the Neuron Kernel Interface (NKI) interpreter or run the NKI-specific tests:
87+
For source installs, if you want to exercise the Neuron Kernel Interface (NKI) interpreter or run the NKI-specific tests:
8288

8389
```sh
8490
uv sync --extra nki # or "uv sync --extra nki --extra test" if also running tests
@@ -98,6 +104,8 @@ uv sync --extra test
98104

99105
## Working with Examples
100106

107+
Examples live in this repo. Clone it first if you installed via pip.
108+
101109
```sh
102110
cd examples
103111
python <file_name>.py

docs/index.html

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@
169169
}
170170
.install-container {
171171
width: 100%;
172-
max-width: 800px;
172+
max-width: 960px;
173173
margin: 0 auto 3rem;
174174
}
175175
.install-box {
@@ -576,28 +576,18 @@ <h1>Analyze and debug your tile-based DSL kernels</h1>
576576
<div class="install-container">
577577
<div class="install-box">
578578
<div class="install-step">
579-
<div class="install-label">Quick Start (Local Development)</div>
579+
<div class="install-label">Install</div>
580580
<div class="install-command">
581-
<code style="white-space: pre-wrap;"># Step 1: git clone repo
582-
git clone https://github.com/Deep-Learning-Profiling-Tools/triton-viz.git
583-
cd triton-viz
584-
585-
# Step 2: install
586-
uv sync # or "uv sync --extra nki" if you want to visualize NKI kernels
587-
npm install
588-
npm run build:frontend
589-
590-
# Step 3: run
591-
uv run examples/visualizer/matmul.py</code>
592-
<button class="copy-btn" onclick="navigator.clipboard.writeText('git clone https://github.com/Deep-Learning-Profiling-Tools/triton-viz.git\ncd triton-viz\nuv sync\nnpm install\nnpm run build:frontend\nuv run examples/visualizer/matmul.py')" title="Copy to clipboard">
581+
<code style="white-space: pre-wrap;">pip install git+https://github.com/Deep-Learning-Profiling-Tools/triton-viz.git</code>
582+
<button class="copy-btn" onclick="navigator.clipboard.writeText('pip install git+https://github.com/Deep-Learning-Profiling-Tools/triton-viz.git')" title="Copy to clipboard">
593583
<svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><rect x="9" y="9" width="13" height="13" rx="2" ry="2"></rect><path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1"></path></svg>
594584
</button>
595585
</div>
596586
</div>
597587
</div>
598588
<p style="font-size: 0.9rem; color: var(--text-muted); text-align: center; margin-top: 1rem;">
599589
Note: A browser with <strong>WebGL/OpenGL enabled</strong> is required (standard in modern browsers). <br>
600-
See <a href="https://github.com/Deep-Learning-Profiling-Tools/triton-viz#readme" target="_blank" style="color: var(--accent); text-decoration: underline;">README.md</a> for full documentation.
590+
See <a href="https://github.com/Deep-Learning-Profiling-Tools/triton-viz#readme" target="_blank" style="color: var(--accent); text-decoration: underline;">README.md</a> for development installs, frontend builds, and full documentation.
601591
</p>
602592
</div>
603593
</section>

0 commit comments

Comments
 (0)