Merge branch 'main' into redisplay-results

Author: jaredoconnell

.eslintrc.json

@@ -179,6 +179,9 @@ cython_debug/
 *.json
 *.yaml
 
+# But not scenarios
+!src/guidellm/benchmark/scenarios/*.json
+!src/guidellm/benchmark/scenarios/*.yaml
 
 # UI Section - Next.js/React application under src/ui/
 # dependencies
@@ -220,8 +223,8 @@ src/ui/next-env.d.ts
 # Root-level UI config files that should be tracked
 !package.json
 !package-lock.json
-!.eslintrc.json
 !tsconfig.json
 !tsconfig.*.json
 !src/ui/lib
 !src/ui/public/manifest.json
+.eslintcache

.gitignore

@@ -0,0 +1 @@
+npx lint-staged

.husky/pre-commit

@@ -12,7 +12,7 @@
 !tests/ui/**/*.json
 
 # Root-level configs to format
-!/.eslintrc.json
+!/.eslint.config.js
 !/tsconfig*.json
 !/*.config.{js,ts}
 !/jest.setup.ts

.prettierignore

@@ -185,7 +185,13 @@ The GuideLLM project includes a frontend UI located in `src/ui`, built using [Ne
 
 ### Getting Started
 
-To start the local development server:
+First, install dependencies:
+
+```bash
+npm install
+```
+
+Then, start the local development server:
 
 ```bash
 npm run dev
@@ -215,6 +221,12 @@ npm run build
   npm run test:integration
   ```
 
+- **Integration+Unit tests with coverage**:
+
+  ```bash
+  npm run coverage
+  ```
+
 - **End-to-end tests** (using Cypress, ensure live dev server):
 
   ```bash
@@ -241,6 +253,20 @@ npm run build
   npm run type-checks
   ```
 
+##### Tagging Tests
+
+Reference [https://www.npmjs.com/package/jest-runner-groups](jest-runner-groups) Add @group with the tag in a docblock at the top of the test file to indicate which types of tests are contained within. Can't distinguish between different types of tests in the same file.
+
+```
+/**
+ * Admin dashboard tests
+ *
+ * @group smoke
+ * @group sanity
+ * @group regression
+ */
+```
+
 ## Additional Resources
 
 - [CONTRIBUTING.md](https://github.com/neuralmagic/guidellm/blob/main/CONTRIBUTING.md): Guidelines for contributing to the project.

DEVELOPING.md

@@ -153,6 +153,48 @@ The `guidellm benchmark` command is used to run benchmarks against a generative
 
 - `--output-path`: Defines the path to save the benchmark results. Supports JSON, YAML, or CSV formats. If a directory is provided, the results will be saved as `benchmarks.json` in that directory. If not set, the results will be saved in the current working directory.
 
+### GuideLLM UI
+
+GuideLLM UI is a companion frontend for visualizing the results of a GuideLLM benchmark run.
+
+### 🛠 Running the UI
+
+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:
+
+```
+https://neuralmagic.github.io/guidellm/ui/dev/
+```
+
+Open the file in your browser and you're done—no setup required.
+
+2. Build and Serve the UI Locally (For Development) This option is useful if:
+
+- You are actively developing the UI
+
+- You want to test changes to the UI before publishing
+
+- You want full control over how the report is displayed
+
+```bash
+npm install
+npm run build
+npx serve out
+```
+
+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
+
+During UI development, it can be helpful to view sample data. We include a sample benchmark run wired into the Redux store under:
+
+```
+src/lib/store/[runInfo/workloadDetails/benchmarks]WindowData.ts
+```
+
+In the future this will be replaced by a configurable untracked file for dev use.
+
 ## Resources
 
 ### Documentation

README.md

@@ -4,6 +4,6 @@ export default defineConfig({
   e2e: {
     specPattern: 'tests/ui/cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',
     supportFile: 'tests/ui/cypress/support/e2e.ts',
-    baseUrl: 'http://localhost:3000', // optional, but good practice
+    baseUrl: 'http://localhost:3000', // optional
   },
 });

cypress.config.ts

@@ -39,6 +39,13 @@ GuideLLM supports several types of datasets, each with its own advantages and us
 
 Synthetic datasets allow you to generate data on the fly with customizable parameters. This is useful for controlled experiments, stress testing, and simulating specific scenarios. For example, you might want to evaluate how a model handles long prompts or generates outputs with specific characteristics.
 
+For different use cases, here are the recommended dataset profiles to pass as arguments in GuideLLM:
+
+- **Chat**: `--data "prompt_tokens=512,output_tokens=256"`
+- **RAG**: `--data "prompt_tokens=4096,output_tokens=512"`
+- **Summarization**: `--data "prompt_tokens=1024,output_tokens=256"`
+- **Code Generation**: `--data "prompt_tokens=512,output_tokens=512"`
+
 #### Example Commands
 
 ```bash