Skip to content

Commit

Permalink
Add goodput CLI doc which was missing from the main Readme for Genai-…
Browse files Browse the repository at this point in the history
…Perf. (#273)

* Add gooput CLI doc which was missing from the main
Readme for Genai-Perf.

* Updated README_template file.
  • Loading branch information
ganeshku1 authored and lkomali committed Feb 5, 2025
1 parent 4d57f37 commit b0e2232
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
10 changes: 10 additions & 0 deletions genai-perf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,16 @@ An option to enable verbose mode. (default: `False`)

An option to print the version and exit.

##### `-g <list>`
##### `--goodput <list>`

An option to provide constraints in order to compute goodput. Specify goodput
constraints as 'key:value' pairs, where the key is a valid metric name, and the
value is a number representing either milliseconds or a throughput value per
second. For example, 'request_latency:300' or
'output_token_throughput_per_request:600'. Multiple key:value pairs can be
provided, separated by spaces. (default: `None`)

</br>

<!--
Expand Down
12 changes: 11 additions & 1 deletion templates/genai-perf-templates/README_template
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
Expand Down Expand Up @@ -650,6 +650,16 @@ An option to enable verbose mode. (default: `False`)

An option to print the version and exit.

##### `-g <list>`
##### `--goodput <list>`

An option to provide constraints in order to compute goodput. Specify goodput
constraints as 'key:value' pairs, where the key is a valid metric name, and the
value is a number representing either milliseconds or a throughput value per
second. For example, 'request_latency:300' or
'output_token_throughput_per_request:600'. Multiple key:value pairs can be
provided, separated by spaces. (default: `None`)

</br>

<!--
Expand Down

0 comments on commit b0e2232

Please sign in to comment.