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

[Doc] Fix vLLMEngine Doc Page #3791

Merged
merged 7 commits into from
Apr 2, 2024
Merged

[Doc] Fix vLLMEngine Doc Page #3791

merged 7 commits into from
Apr 2, 2024

Conversation

ywang96
Copy link
Collaborator

@ywang96 ywang96 commented Apr 2, 2024

The documentation page is down again for vLLMEngine :(

I'm not sure why but this time we necessarily need to include both transformers and py-cpuinfo in requirements-docs.txt to make it work. See https://vllm--3791.org.readthedocs.build/en/3791/dev/engine/llm_engine.html for a working version.

@ywang96 ywang96 requested a review from simon-mo April 2, 2024 08:27
@simon-mo
Copy link
Collaborator

simon-mo commented Apr 2, 2024

I think it's time to do a proper fix! The root cause of this problem is that readthedocs's builder only install requirements-doc.txt but our CI's doc build have all test dependencies. A good test would be change the existing doc build in CI step to start with a clean python environment (not sure how easy it is to achieve that, maybe just run in a new virtualenv), and only install these packages.

Additionally, the problem can be addressed by using mocking in the conf.py instead of installing heavy weight packages.

@ywang96
Copy link
Collaborator Author

ywang96 commented Apr 2, 2024

I think it's time to do a proper fix! The root cause of this problem is that readthedocs's builder only install requirements-doc.txt but our CI's doc build have all test dependencies. A good test would be change the existing doc build in CI step to start with a clean python environment (not sure how easy it is to achieve that, maybe just run in a new virtualenv), and only install these packages.

Additionally, the problem can be addressed by using mocking in the conf.py instead of installing heavy weight packages.

Make sense - it baffles me why mocking didn't work but I will look into it.

@ywang96 ywang96 merged commit 3bec41f into vllm-project:main Apr 2, 2024
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants