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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc]: API reference for LLM class #4684

Closed
zplizzi opened this issue May 8, 2024 · 2 comments 路 Fixed by #4710
Closed

[Doc]: API reference for LLM class #4684

zplizzi opened this issue May 8, 2024 · 2 comments 路 Fixed by #4710
Labels
documentation Improvements or additions to documentation

Comments

@zplizzi
Copy link

zplizzi commented May 8, 2024

馃摎 The doc issue

I can't find on https://docs.vllm.ai/ the API reference for the LLM class. This would make it easier than digging through the code to look at the docstrings - the examples in the docs don't explain most of the arguments.

Suggest a potential alternative/fix

No response
@zplizzi zplizzi added the documentation Improvements or additions to documentation label May 8, 2024
@zplizzi
Copy link
Author

zplizzi commented May 8, 2024

I guess they are largely overlapping with the engine arguments, but this isn't obvious, as the two classes have pretty different purposes.

@DarkLight1337 DarkLight1337 mentioned this issue May 9, 2024
Merged
@DarkLight1337
Copy link
Contributor

DarkLight1337 commented May 9, 2024 •
edited

I have opened #4709 #4710 to add some documentation for offline inference. Is there anything else you want to be included?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Doc] Add API reference for offline inference DarkLight1337/vllm-rocm
2 participants
@zplizzi @DarkLight1337