Skip to content

Commit c2eb830

Browse files
committed
update readme to remove stuff that isn't landed yet
1 parent 2672132 commit c2eb830

File tree

1 file changed

+1
-35
lines changed

1 file changed

+1
-35
lines changed

README.md

Lines changed: 1 addition & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -159,41 +159,7 @@ GuideLLM UI is a companion frontend for visualizing the results of a GuideLLM be
159159

160160
### 🛠 Running the UI
161161

162-
1. Use the Hosted Build (Recommended for Most Users)
163-
164-
After running a benchmark with GuideLLM, a report.html file will be generated (by default at guidellm_report/report.html). This file references the latest stable version of the UI hosted at:
165-
166-
```
167-
https://neuralmagic.github.io/guidellm/ui/dev/
168-
```
169-
170-
Open the file in your browser and you're done—no setup required.
171-
172-
2. Build and Serve the UI Locally (For Development) This option is useful if:
173-
174-
- You are actively developing the UI
175-
176-
- You want to test changes to the UI before publishing
177-
178-
- You want full control over how the report is displayed
179-
180-
```bash
181-
npm install
182-
npm run build
183-
npx serve out
184-
```
185-
186-
This will start a local server (e.g., at http://localhost:3000). Then, in your GuideLLM config or CLI flags, point to this local server as the asset base for report generation.
187-
188-
### 🧪 Development Notes
189-
190-
During UI development, it can be helpful to view sample data. We include a sample benchmark run wired into the Redux store under:
191-
192-
```
193-
src/lib/store/[runInfo/workloadDetails/benchmarks]WindowData.ts
194-
```
195-
196-
In the future this will be replaced by a configurable untracked file for dev use.
162+
The UI is a WIP, check more recent PRs for the latest updates
197163

198164
## Resources
199165

0 commit comments

Comments
 (0)