Skip to content

Commit c0baf33

Browse files
committed
Update documentation to reflect command change
1 parent 83b0c77 commit c0baf33

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ For information on starting other supported inference servers or platforms, see
6868

6969
#### 2. Run a GuideLLM Benchmark
7070

71-
To run a GuideLLM benchmark, use the `guidellm benchmark` command with the target set to an OpenAI-compatible server. For this example, the target is set to 'http://localhost:8000', assuming that vLLM is active and running on the same server. Otherwise, update it to the appropriate location. By default, GuideLLM automatically determines the model available on the server and uses it. To target a different model, pass the desired name with the `--model` argument. Additionally, the `--rate-type` is set to `sweep`, which automatically runs a range of benchmarks to determine the minimum and maximum rates that the server and model can support. Each benchmark run under the sweep will run for 30 seconds, as set by the `--max-seconds` argument. Finally, `--data` is set to a synthetic dataset with 256 prompt tokens and 128 output tokens per request. For more arguments, supported scenarios, and configurations, jump to the [Configurations Section](#configurations) or run `guidellm benchmark --help`.
71+
To run a GuideLLM benchmark, use the `guidellm benchmark run` command with the target set to an OpenAI-compatible server. For this example, the target is set to 'http://localhost:8000', assuming that vLLM is active and running on the same server. Otherwise, update it to the appropriate location. By default, GuideLLM automatically determines the model available on the server and uses it. To target a different model, pass the desired name with the `--model` argument. Additionally, the `--rate-type` is set to `sweep`, which automatically runs a range of benchmarks to determine the minimum and maximum rates that the server and model can support. Each benchmark run under the sweep will run for 30 seconds, as set by the `--max-seconds` argument. Finally, `--data` is set to a synthetic dataset with 256 prompt tokens and 128 output tokens per request. For more arguments, supported scenarios, and configurations, jump to the [Configurations Section](#configurations) or run `guidellm benchmark --help`.
7272

7373
Now, to start benchmarking, run the following command:
7474

7575
```bash
76-
guidellm benchmark \
76+
guidellm benchmark run \
7777
--target "http://localhost:8000" \
7878
--rate-type sweep \
7979
--max-seconds 30 \
@@ -110,11 +110,11 @@ For further details on determining the optimal request rate and SLOs, refer to t
110110

111111
### Configurations
112112

113-
GuideLLM offers a range of configurations through both the benchmark CLI command and environment variables, which provide default values and more granular controls. The most common configurations are listed below. A complete list is easily accessible, though, by running `guidellm benchmark --help` or `guidellm config` respectively.
113+
GuideLLM offers a range of configurations through both the benchmark CLI command and environment variables, which provide default values and more granular controls. The most common configurations are listed below. A complete list is easily accessible, though, by running `guidellm benchmark run --help` or `guidellm config` respectively.
114114

115115
#### Benchmark CLI
116116

117-
The `guidellm benchmark` command is used to run benchmarks against a generative AI backend/server. The command accepts a variety of arguments to customize the benchmark run. The most common arguments include:
117+
The `guidellm benchmark run` command is used to run benchmarks against a generative AI backend/server. The command accepts a variety of arguments to customize the benchmark run. The most common arguments include:
118118

119119
- `--target`: Specifies the target path for the backend to run benchmarks against. For example, `http://localhost:8000`. This is required to define the server endpoint.
120120

docs/datasets.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The following arguments can be used to configure datasets and their processing:
2020
### Example Usage
2121

2222
```bash
23-
guidellm benchmark \
23+
guidellm benchmark run \
2424
--target "http://localhost:8000" \
2525
--rate-type "throughput" \
2626
--max-requests 1000 \
@@ -49,7 +49,7 @@ For different use cases, here are the recommended dataset profiles to pass as ar
4949
#### Example Commands
5050

5151
```bash
52-
guidellm benchmark \
52+
guidellm benchmark run \
5353
--target "http://localhost:8000" \
5454
--rate-type "throughput" \
5555
--max-requests 1000 \
@@ -59,7 +59,7 @@ guidellm benchmark \
5959
Or using a JSON string:
6060

6161
```bash
62-
guidellm benchmark \
62+
guidellm benchmark run \
6363
--target "http://localhost:8000" \
6464
--rate-type "throughput" \
6565
--max-requests 1000 \
@@ -90,7 +90,7 @@ GuideLLM supports datasets from the Hugging Face Hub or local directories that f
9090
#### Example Commands
9191

9292
```bash
93-
guidellm benchmark \
93+
guidellm benchmark run \
9494
--target "http://localhost:8000" \
9595
--rate-type "throughput" \
9696
--max-requests 1000 \
@@ -100,7 +100,7 @@ guidellm benchmark \
100100
Or using a local dataset:
101101

102102
```bash
103-
guidellm benchmark \
103+
guidellm benchmark run \
104104
--target "http://localhost:8000" \
105105
--rate-type "throughput" \
106106
--max-requests 1000 \
@@ -152,7 +152,7 @@ GuideLLM supports various file formats for datasets, including text, CSV, JSON,
152152
#### Example Commands
153153

154154
```bash
155-
guidellm benchmark \
155+
guidellm benchmark run \
156156
--target "http://localhost:8000" \
157157
--rate-type "throughput" \
158158
--max-requests 1000 \

docs/outputs.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ GuideLLM provides flexible options for outputting benchmark results, catering to
55
For all of the output formats, `--output-extras` can be used to include additional information. This could include tags, metadata, hardware details, and other relevant information that can be useful for analysis. This must be supplied as a JSON encoded string. For example:
66

77
```bash
8-
guidellm benchmark \
8+
guidellm benchmark run \
99
--target "http://localhost:8000" \
1010
--rate-type sweep \
1111
--max-seconds 30 \
@@ -26,21 +26,21 @@ By default, GuideLLM displays benchmark results and progress directly in the con
2626

2727
### Disabling Console Output
2828

29-
To disable the progress outputs to the console, use the `disable-progress` flag when running the `guidellm benchmark` command. For example:
29+
To disable the progress outputs to the console, use the `disable-progress` flag when running the `guidellm benchmark run` command. For example:
3030

3131
```bash
32-
guidellm benchmark \
32+
guidellm benchmark run \
3333
--target "http://localhost:8000" \
3434
--rate-type sweep \
3535
--max-seconds 30 \
3636
--data "prompt_tokens=256,output_tokens=128" \
3737
--disable-progress
3838
```
3939

40-
To disable console output, use the `--disable-console-outputs` flag when running the `guidellm benchmark` command. For example:
40+
To disable console output, use the `--disable-console-outputs` flag when running the `guidellm benchmark run` command. For example:
4141

4242
```bash
43-
guidellm benchmark \
43+
guidellm benchmark run \
4444
--target "http://localhost:8000" \
4545
--rate-type sweep \
4646
--max-seconds 30 \
@@ -50,10 +50,10 @@ guidellm benchmark \
5050

5151
### Enabling Extra Information
5252

53-
GuideLLM includes the option to display extra information during the benchmark runs to monitor the overheads and performance of the system. This can be enabled by using the `--display-scheduler-stats` flag when running the `guidellm benchmark` command. For example:
53+
GuideLLM includes the option to display extra information during the benchmark runs to monitor the overheads and performance of the system. This can be enabled by using the `--display-scheduler-stats` flag when running the `guidellm benchmark run` command. For example:
5454

5555
```bash
56-
guidellm benchmark \
56+
guidellm benchmark run \
5757
--target "http://localhost:8000" \
5858
--rate-type sweep \
5959
--max-seconds 30 \
@@ -81,7 +81,7 @@ GuideLLM supports saving benchmark results to files in various formats, includin
8181
Example command to save results in YAML format:
8282

8383
```bash
84-
guidellm benchmark \
84+
guidellm benchmark run \
8585
--target "http://localhost:8000" \
8686
--rate-type sweep \
8787
--max-seconds 30 \

0 commit comments

Comments
 (0)