You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-19Lines changed: 10 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -157,17 +157,18 @@ The `guidellm benchmark` command is used to run benchmarks against a generative
157
157
158
158
GuideLLM UI is a companion frontend for visualizing the results of a GuideLLM benchmark run.
159
159
160
-
### 🛠 Running the UI
160
+
### 🛠 Generating an HTML report with a benchmark run
161
161
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
+
```
163
166
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)
165
168
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.
169
170
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.
171
172
172
173
2. Build and Serve the UI Locally (For Development) This option is useful if:
173
174
@@ -180,20 +181,10 @@ Open the file in your browser and you're done—no setup required.
180
181
```bash
181
182
npm install
182
183
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:
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.
0 commit comments