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.

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

docs: Update README.md #63

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Update README.md #63

wants to merge 1 commit into from

Conversation

yinggeh
Copy link
Contributor

@yinggeh yinggeh commented Sep 6, 2024

List metrics in vllm:* instead of the variable name.

@yinggeh yinggeh added the documentation Improvements or additions to documentation label Sep 6, 2024
@yinggeh yinggeh self-assigned this Sep 6, 2024
counter_prompt_tokens
# Number of generation tokens processed.
counter_generation_tokens
# Counter of prefill tokens processed.
Copy link
Contributor

@rmccorm4 rmccorm4 Sep 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need both this section and the one right below it? Why not just use the below section instead?

VLLM stats are reported by the metrics endpoint in fields that are prefixed with
vllm:. For example, the metrics reported by Triton will look similar to the following:

# HELP vllm:prompt_tokens_total Number of prefill tokens processed.
# TYPE vllm:prompt_tokens_total counter
vllm:prompt_tokens_total{model="vllm_model",version="1"} 10
# HELP vllm:generation_tokens_total Number of generation tokens processed.
# TYPE vllm:generation_tokens_total counter
vllm:generation_tokens_total{model="vllm_model",version="1"} 16
...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather have another section listing all supported metrics. The sample metrics output is just hard to follow IMO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And for example, changing counter_prompt_tokens to vllm:prompt_tokens_total allows reader to easily locate the corresponding output from below section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oandreeva-nv do you mind driving this PR if you have time?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about we create a dedicated doc for metrics? So that our front facing README is nice and non-cluttered ?

@yinggeh yinggeh requested a review from rmccorm4 September 6, 2024 23:51
@yinggeh yinggeh changed the title Update README.md docs: Update README.md Sep 18, 2024
@yinggeh
Copy link
Contributor Author

yinggeh commented Sep 24, 2024

There will be changes to the vLLM backend metrics in the upcoming releases. Converting this PR to draft. @oandreeva-nv @rmccorm4

@yinggeh yinggeh marked this pull request as draft September 24, 2024 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants