Skip to content

Save as html #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 30 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
608bc1f
add html save functionality
DaltheCow Jun 16, 2025
a33b55f
push up hopefully working build to test with guidellm after the previ…
DaltheCow Jun 18, 2025
c7adecb
Merge branch 'main' into save-as-html
DaltheCow Jun 18, 2025
76e1b4b
Merge branch 'implement-ui-build-pipeline' into save-as-html
DaltheCow Jun 18, 2025
2f46ad2
fix broken test, type issues
DaltheCow Jun 18, 2025
dd1cef3
run precommit, style fixes, but not all passing
DaltheCow Jun 18, 2025
cfc3797
Merge branch 'save-as-html' of github.com:neuralmagic/guidellm into s…
DaltheCow Jun 18, 2025
db9d957
get ui working locally
DaltheCow Jun 18, 2025
917f4f6
update injector to only read from in <head>
DaltheCow Jun 18, 2025
835d292
fix case with only one benchmark
DaltheCow Jun 19, 2025
9b384e9
fix all known bugs, add details for locally hosted UI, remove broken …
DaltheCow Jun 20, 2025
1f64255
remove benchmarks.html
DaltheCow Jun 20, 2025
7368fdc
set mock data flag back in pr build
DaltheCow Jun 20, 2025
c62e7b9
remove comments in save html method
DaltheCow Jun 20, 2025
4ef69bd
Merge branch 'save-as-html' of github.com:neuralmagic/guidellm into s…
DaltheCow Jun 20, 2025
d4b0481
remove console.log
DaltheCow Jun 20, 2025
d4af227
fix broken unit tests
DaltheCow Jun 23, 2025
8fae0a1
try to fix type error in test
DaltheCow Jun 23, 2025
904a4dd
fix type issues
DaltheCow Jun 23, 2025
f41fea6
fix all quality/typing issues
DaltheCow Jun 23, 2025
aaf74d2
merge base
DaltheCow Jun 23, 2025
45f8c42
Merge branch 'implement-ui-build-pipeline' into save-as-html
DaltheCow Jun 23, 2025
bf09d65
fix trailing line issue
DaltheCow Jun 24, 2025
408f5e8
Merge branch 'implement-ui-build-pipeline' into save-as-html
DaltheCow Jun 24, 2025
c3595d3
merge base
DaltheCow Jun 24, 2025
4e05b16
merge base
DaltheCow Jun 24, 2025
a4f60ac
add computed field back into data_models (this will fail the CI check…
DaltheCow Jun 24, 2025
1b66b68
remove @property
DaltheCow Jun 24, 2025
e9972e0
fix log scaled y axis in charts
DaltheCow Jun 30, 2025
80a6709
Merge branch 'implement-ui-build-pipeline' into save-as-html
DaltheCow Jun 30, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,11 @@ jobs:
with:
fetch-depth: 0

- name: Set up Node.js 22
uses: actions/setup-node@v4
with:
node-version: '22'

- name: Check if UI-related files changed
id: check-changes
run: |
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ src/guidellm/version.py
benchmarks.json
benchmarks.yaml
benchmarks.csv
benchmarks.html

# Byte-compiled / optimized / DLL files
__pycache__/
Expand Down Expand Up @@ -227,4 +228,5 @@ src/ui/next-env.d.ts
!tsconfig.*.json
!src/ui/lib
!src/ui/public/manifest.json
!src/ui/serve.json
.eslintcache
10 changes: 10 additions & 0 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,16 @@ Reference [https://www.npmjs.com/package/jest-runner-groups](jest-runner-groups)
*/
```

### 🧪 UI Development Notes

During development, it can be helpful to view sample data. We include a sample benchmark run wired into the Redux store under:

```
src/ui/lib/store/[runInfo/workloadDetails/benchmarks]WindowData.ts
```

In the future this will be replaced by a configurable untracked file for dev use.

## Additional Resources

- [CONTRIBUTING.md](https://github.com/neuralmagic/guidellm/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project.
Expand Down
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,17 +157,19 @@ The `guidellm benchmark` command is used to run benchmarks against a generative

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

### 🛠 Running the UI
### 🛠 Generating an HTML report with a benchmark run

1. Use the Hosted Build (Recommended for Most Users)

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:
Set the output to benchmarks.html for your run:

```base
--output-path=benchmarks.html
```
https://neuralmagic.github.io/guidellm/ui/dev/
```

Open the file in your browser and you're done—no setup required.
1. Use the Hosted Build (Recommended for Most Users)

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.

Open benchmarks.html in your browser and you're done—no setup required.

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

Expand All @@ -180,20 +182,16 @@ Open the file in your browser and you're done—no setup required.
```bash
npm install
npm run build
npx serve out
npm run serve
```

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.

### 🧪 Development Notes
This will start a local server (e.g., at http://localhost:3000). Then set the Environment to LOCAL before running your benchmarks.

During UI development, it can be helpful to view sample data. We include a sample benchmark run wired into the Redux store under:
```bash
export GUIDELLM__ENV=local

Alternatively, in config.py update the ENV_REPORT_MAPPING used as the asset base for report generation to the LOCAL option.
```
src/lib/store/[runInfo/workloadDetails/benchmarks]WindowData.ts
```

In the future this will be replaced by a configurable untracked file for dev use.

## Resources

Expand Down
Loading