Skip to content

Commit 14ba613

Browse files
DaltheCowdependabot[bot]sjmonsonmarkurtzCopilot
authored
implement html output, fix log scaling in charts (#218)
To clarify all of the UI changes here, there was a previous version of the UI that worked with an older version of guidellm and the code used to generate the html report provided the UI with a different data format. Most of the UI changes here are needed to get things up to date with the current version of guidellm and how the html reporting logic generates data. There are a few specific changes in these files to get logarithmic scaling working which I found was broken after making these changes, in hindsight I would have split these out into another PR: src/ui/lib/components/Charts/DashedLine/DashedLine.component.tsx src/ui/lib/components/Charts/DashedLine/helpers.ts src/ui/lib/components/Charts/MetricLine/MetricLine.component.tsx tests/ui/unit/components/Charts/DashedLine/helpers.test.ts There were a few other tiny bug fixes as well. --------- Signed-off-by: dalthecow <dalcowboiz@gmail.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Samuel Monson <smonson@redhat.com> Co-authored-by: Mark Kurtz <mark.j.kurtz@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent f1f8ca8 commit 14ba613

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+3298
-1449
lines changed

.github/workflows/development.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,11 @@ jobs:
246246
with:
247247
fetch-depth: 0
248248

249+
- name: Set up Node.js 22
250+
uses: actions/setup-node@v4
251+
with:
252+
node-version: '22'
253+
249254
- name: Check if UI-related files changed
250255
id: check-changes
251256
run: |
@@ -276,7 +281,7 @@ jobs:
276281
echo "pr_number=${PR_NUMBER}" >> $GITHUB_OUTPUT
277282
278283
# Set asset prefix and base path with PR number
279-
ASSET_PREFIX=https://neuralmagic.github.io/guidellm/ui/pr/${PR_NUMBER}
284+
ASSET_PREFIX=https://blog.vllm.ai/guidellm/ui/pr/${PR_NUMBER}
280285
USE_MOCK_DATA=true
281286
BASE_PATH=/ui/pr/${PR_NUMBER}
282287
GIT_SHA=${{ github.sha }}
@@ -303,7 +308,7 @@ jobs:
303308
if: steps.check-changes.outputs.should_build == 'true'
304309
id: deploy
305310
run: |
306-
DEPLOY_URL=https://neuralmagic.github.io/guidellm/ui/pr/${{ steps.build.outputs.pr_number }}
311+
DEPLOY_URL=https://blog.vllm.ai/guidellm/ui/pr/${{ steps.build.outputs.pr_number }}
307312
echo "url=${DEPLOY_URL}" >> $GITHUB_OUTPUT
308313
309314
- name: Find PR comment

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ jobs:
205205
export $(grep -v '^#' .env.development | xargs)
206206
207207
# Set asset prefix and base path with PR number
208-
ASSET_PREFIX=https://neuralmagic.github.io/guidellm/ui/dev
208+
ASSET_PREFIX=https://blog.vllm.ai/guidellm/ui/dev
209209
BASE_PATH=/ui/dev
210210
GIT_SHA=${{ github.sha }}
211211
export ASSET_PREFIX=${ASSET_PREFIX}

.github/workflows/nightly.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ jobs:
226226
export $(grep -v '^#' .env.staging | xargs)
227227
228228
# Set asset prefix and base path with git tag
229-
ASSET_PREFIX=https://neuralmagic.github.io/guidellm/ui/nightly
229+
ASSET_PREFIX=https://blog.vllm.ai/guidellm/ui/nightly
230230
BASE_PATH=/ui/nightly
231231
GIT_SHA=${{ github.sha }}
232232
export ASSET_PREFIX=${ASSET_PREFIX}

.github/workflows/release-candidate.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ jobs:
216216
export $(grep -v '^#' .env.staging | xargs)
217217
218218
# Set asset prefix and base path with git tag
219-
ASSET_PREFIX=https://neuralmagic.github.io/guidellm/ui/release/${TAG}
219+
ASSET_PREFIX=https://blog.vllm.ai/guidellm/ui/release/${TAG}
220220
BASE_PATH=/ui/release/${TAG}
221221
GIT_SHA=${{ github.sha }}
222222
export ASSET_PREFIX=${ASSET_PREFIX}
@@ -270,7 +270,7 @@ jobs:
270270
export $(grep -v '^#' .env.staging | xargs)
271271
272272
# Set asset prefix and base path with git tag
273-
ASSET_PREFIX=https://neuralmagic.github.io/guidellm/ui/release/latest
273+
ASSET_PREFIX=https://blog.vllm.ai/guidellm/ui/release/latest
274274
BASE_PATH=/ui/release/latest
275275
GIT_SHA=${{ github.sha }}
276276
export ASSET_PREFIX=${ASSET_PREFIX}

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ jobs:
215215
export $(grep -v '^#' .env.production | xargs)
216216
217217
# Set asset prefix and base path with git tag
218-
ASSET_PREFIX=https://neuralmagic.github.io/guidellm/ui/${TAG}
218+
ASSET_PREFIX=https://blog.vllm.ai/guidellm/ui/${TAG}
219219
BASE_PATH=/ui/${TAG}
220220
GIT_SHA=${{ github.sha }}
221221
export ASSET_PREFIX=${ASSET_PREFIX}
@@ -269,7 +269,7 @@ jobs:
269269
export $(grep -v '^#' .env.production | xargs)
270270
271271
# Set asset prefix and base path with git tag
272-
ASSET_PREFIX=https://neuralmagic.github.io/guidellm/ui/latest
272+
ASSET_PREFIX=https://blog.vllm.ai/guidellm/ui/latest
273273
BASE_PATH=/ui/latest
274274
GIT_SHA=${{ github.sha }}
275275
export ASSET_PREFIX=${ASSET_PREFIX}

.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__/
@@ -227,4 +228,5 @@ src/ui/next-env.d.ts
227228
!tsconfig.*.json
228229
!src/ui/lib
229230
!src/ui/public/manifest.json
231+
!src/ui/serve.json
230232
.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
### Logging
271281

272282
Logging is useful for learning how GuideLLM works and finding problems.

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,9 +157,43 @@ 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-
The UI is a WIP, check more recent PRs for the latest updates
162+
1. Use the Hosted Build (Recommended for Most Users)
163+
164+
This is preconfigured. The latest stable version of the hosted UI (https://blog.vllm.ai/guidellm/ui/latest) will be used to build the local html file.
165+
166+
Open benchmarks.html in your browser and you're done—no setup required.
167+
168+
2. Build and Serve the UI Locally (For Development) This option is useful if:
169+
170+
- You are actively developing the UI
171+
172+
- You want to test changes to the UI before publishing
173+
174+
- You want full control over how the report is displayed
175+
176+
```bash
177+
npm install
178+
npm run build
179+
npm run serve
180+
```
181+
182+
This will start a local server (e.g., at http://localhost:3000). Then set the Environment to LOCAL before running your benchmarks.
183+
184+
```bash
185+
export GUIDELLM__ENV=local
186+
```
187+
188+
Then you can execute your run.
189+
190+
Set the output to benchmarks.html for your run:
191+
192+
```bash
193+
--output-path=benchmarks.html
194+
```
195+
196+
Alternatively load a saved run using the from-file command and also set the output to benchmarks.html
163197

164198
## Resources
165199

0 commit comments

Comments
 (0)