Skip to content

Commit 9b384e9

Browse files
committed
fix all known bugs, add details for locally hosted UI, remove broken log scaling on y axis
1 parent 835d292 commit 9b384e9

File tree

17 files changed

+845
-43
lines changed

17 files changed

+845
-43
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ src/guidellm/version.py
66
benchmarks.json
77
benchmarks.yaml
88
benchmarks.csv
9+
benchmarks.html
910

1011
# Byte-compiled / optimized / DLL files
1112
__pycache__/
@@ -224,4 +225,5 @@ src/ui/next-env.d.ts
224225
!tsconfig.*.json
225226
!src/ui/lib
226227
!src/ui/public/manifest.json
228+
!src/ui/serve.json
227229
.eslintcache

DEVELOPING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,16 @@ Reference [https://www.npmjs.com/package/jest-runner-groups](jest-runner-groups)
267267
*/
268268
```
269269

270+
### 🧪 UI Development Notes
271+
272+
During development, it can be helpful to view sample data. We include a sample benchmark run wired into the Redux store under:
273+
274+
```
275+
src/ui/lib/store/[runInfo/workloadDetails/benchmarks]WindowData.ts
276+
```
277+
278+
In the future this will be replaced by a configurable untracked file for dev use.
279+
270280
## Additional Resources
271281

272282
- [CONTRIBUTING.md](https://github.com/neuralmagic/guidellm/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project.

README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -157,17 +157,18 @@ The `guidellm benchmark` command is used to run benchmarks against a generative
157157

158158
GuideLLM UI is a companion frontend for visualizing the results of a GuideLLM benchmark run.
159159

160-
### 🛠 Running the UI
160+
### 🛠 Generating an HTML report with a benchmark run
161161

162-
1. Use the Hosted Build (Recommended for Most Users)
162+
Set the output to benchmarks.html for your run:
163+
```base
164+
--output-path=benchmarks.html
165+
```
163166

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:
167+
1. Use the Hosted Build (Recommended for Most Users)
165168

166-
```
167-
https://neuralmagic.github.io/guidellm/ui/dev/
168-
```
169+
This is preconfigured. The latest stable version of the hosted UI (https://neuralmagic.github.io/guidellm/ui/latest) will be used to build the local html file.
169170

170-
Open the file in your browser and you're done—no setup required.
171+
Open benchmarks.html in your browser and you're done—no setup required.
171172

172173
2. Build and Serve the UI Locally (For Development) This option is useful if:
173174

@@ -180,20 +181,10 @@ Open the file in your browser and you're done—no setup required.
180181
```bash
181182
npm install
182183
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
184+
npm run serve
194185
```
195186

196-
In the future this will be replaced by a configurable untracked file for dev use.
187+
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. You can set the Environment to LOCAL before running your benchmarks to accomplish this.
197188

198189
## Resources
199190

0 commit comments

Comments
 (0)