diff --git a/README.md b/README.md index b1abc75f..55f8e815 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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