You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix outputs documentation with correct parameter syntax
Correct the --outputs parameter examples to show comma-separated values
instead of space-separated, which doesn't work in all environments.
The parameter supports comma-separated format aliases or multiple flags.
Signed-off-by: Maryam Tahhan <[email protected]>
Copy file name to clipboardExpand all lines: docs/guides/outputs.md
+62-2Lines changed: 62 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,16 +66,76 @@ GuideLLM supports saving benchmark results to files in various formats, includin
66
66
-**Output Formats**: Use the `--outputs` argument to specify which formats or exact file names (with supported file extensions, e.g. `benchmarks.json`) to generate. By default, JSON, CSV, and HTML are generated.
67
67
-**Sampling**: To limit the size of the output files and number of detailed request samples included, you can configure sampling options using the `--sample-requests` argument.
68
68
69
-
Example command to save results in specific formats:
69
+
#### Example commands to save results in specific formats:
70
70
71
+
The `--outputs` parameter accepts output formats in the following ways:
72
+
73
+
**Command Line:**
74
+
```bash
75
+
# Comma-separated format aliases (recommended)
76
+
--outputs json,csv,html
77
+
78
+
# Or using multiple flags
79
+
--outputs json --outputs csv --outputs html
80
+
```
81
+
82
+
**Environment Variables:**
83
+
```bash
84
+
# Comma-separated values for environment variables
85
+
-e GUIDELLM_OUTPUTS=json,csv,html
86
+
```
87
+
88
+
#### Examples
89
+
90
+
**Example 1: Comma-separated format aliases (recommended)**
91
+
```bash
92
+
guidellm benchmark \
93
+
--target "http://localhost:8000" \
94
+
--profile sweep \
95
+
--max-seconds 30 \
96
+
--data "prompt_tokens=256,output_tokens=128" \
97
+
--output-dir "results/" \
98
+
--outputs json,csv,html \
99
+
--sample-requests 20
100
+
```
101
+
102
+
**Example 2: Multiple flags for each format**
103
+
```bash
104
+
guidellm benchmark \
105
+
--target "http://localhost:8000" \
106
+
--profile sweep \
107
+
--max-seconds 30 \
108
+
--data "prompt_tokens=256,output_tokens=128" \
109
+
--output-dir "results/" \
110
+
--outputs json \
111
+
--outputs csv \
112
+
--outputs html \
113
+
--sample-requests 20
114
+
```
115
+
116
+
**Example 3: Using environment variables (Docker/Podman)**
0 commit comments