Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add goodput CLI doc which was missing from the main Readme for Genai-Perf. #273

Merged
merged 2 commits into from
Feb 5, 2025
Merged

Add goodput CLI doc which was missing from the main Readme for Genai-Perf. #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a13b984
Add gooput CLI doc which was missing from the main
ganeshku1 Feb 5, 2025
f5443ce
Updated README_template file.
ganeshku1 Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions genai-perf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,6 +617,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`)

dyastremsky marked this conversation as resolved.
Show resolved Hide resolved
</br>

<!--
Expand Down
12 changes: 11 additions & 1 deletion templates/genai-perf-templates/README_template
View file
Open in desktop
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 @@ -617,6 +617,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
Loading