-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
[DOC] Add additional comments for LLMEngine and AsyncLLMEngine #1011
Conversation
Close the PR to fix the TODOs at the moment. |
Hi @litone01, sorry for the very late review and many thanks for the contribution. I've tried the PR in my laptop and got this error:
The generated doc does not contain anything under |
Thanks @WoosukKwon ! Is it because you are not using the correct python environment? This requires the python dependencies that we used for compilation and development to be present in the environment. For example, the
|
Could I seek your advice on the following error during doc compilation that happens after my latest rebase?
My guess is two reasons:
Thank you! |
I think this is because @litone01 are you able to continue to work on this? Thank you! |
Thanks for the suggestion! Sure, I will take a closer look as soon as I have the bandwidth. I may need slightly more time to update the documentation with the latest code again. Thanks! |
For the following functions:
LLMEngine
:add_request
,abort_request
,step
and_init_cache
AsyncLLMEngine
:generate
andabort
Summary of changes:
LLMEngine
andAsyncLLMEngine
. To address questions related to memory usage, the documentation forinit_cache
fromLLMEngine
is also added.TODO:
Discussion:
Partially addresses the documentation issues in #244.
Could you kindly review this PR? Thanks! @zhuohan123 @WoosukKwon cc @LiuXiaoxuanPKU