Skip to content

update ui readme #247

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Aug 5, 2025
Merged

update ui readme #247

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ac8bff8
update ui readme
DaltheCow Jul 28, 2025
c77d076
Merge branch 'main' into update-ui-readme
sjmonson Aug 4, 2025
fe06788
Merge branch 'main' into update-ui-readme
DaltheCow Aug 5, 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
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,19 @@ GuideLLM UI is a companion frontend for visualizing the results of a GuideLLM be

### 🛠 Generating an HTML report with a benchmark run

For either pathway below you'll need to set the output path to benchmarks.html for your run:

```bash
--output-path=benchmarks.html
```

Alternatively load a saved run using the from-file command and also set the output to benchmarks.html

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

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.

Open benchmarks.html in your browser and you're done—no setup required.
Execute your run, then open benchmarks.html in your browser and you're done—no further setup required.

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

Expand All @@ -206,14 +214,6 @@ export GUIDELLM__ENV=local

Then you can execute your run.

Set the output to benchmarks.html for your run:

```bash
--output-path=benchmarks.html
```

Alternatively load a saved run using the from-file command and also set the output to benchmarks.html

## Resources

### Documentation
Expand Down