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

Fix autodoc directives #4272

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Conversation

hmellor
Copy link
Collaborator

@hmellor hmellor commented Apr 22, 2024

Documentation updates:

  • Update SamplingParams to use autoclass instead of automodule so that the SamplingParams class is properly documented.
  • Add :members: option to SamplingParams so it is fully documented.
  • Remove specific :members: from AsyncLLMEngine and LLMEngine because they weren't being kept up to date and functions were missing. :members: will only document public class members anyway.
  • Update import paths used in autoclass for AsyncLLMEngine and LLMEngine so that they match the way we expect users to import them.

@hmellor hmellor requested review from simon-mo and zhuohan123 April 22, 2024 19:44
@simon-mo simon-mo enabled auto-merge (squash) April 22, 2024 20:27
@simon-mo simon-mo merged commit 34128a6 into vllm-project:main Apr 23, 2024
47 checks passed
xjpang pushed a commit to xjpang/vllm that referenced this pull request Apr 25, 2024
robertgshaw2-neuralmagic pushed a commit to neuralmagic/nm-vllm that referenced this pull request Apr 26, 2024
alexeykondrat pushed a commit to alexeykondrat/ci-vllm that referenced this pull request May 1, 2024
z103cb pushed a commit to z103cb/opendatahub_vllm that referenced this pull request May 7, 2024
Temirulan pushed a commit to Temirulan/vllm-whisper that referenced this pull request Sep 6, 2024
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.

2 participants