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] Move guide for multimodal model and other improvements #6168

Merged
merged 11 commits into from
Jul 6, 2024

Conversation

DarkLight1337
Copy link
Member

This PR primarily moves the multimodal model guide under "Models" section for more visibility. Some other changes:

  • Clean up the input processing and multimodal docs.
  • Reduce nesting of "Developer Documentation" in the main page since it's a bit spammy.

@DarkLight1337 DarkLight1337 requested a review from ywang96 July 6, 2024 06:14
docs/source/models/adding_model.rst Show resolved Hide resolved
docs/source/models/adding_multimodal_model.rst Outdated Show resolved Hide resolved
@DarkLight1337
Copy link
Member Author

I've renamed the guide to "Enabling Multimodal Inputs" to avoid overlap with the base "Adding a New Model". PTAL again.

@DarkLight1337 DarkLight1337 requested a review from ywang96 July 6, 2024 06:53
Comment on lines -8 to -15
.. note::
The complexity of adding a new model depends heavily on the model's architecture.
The process is considerably straightforward if the model shares a similar architecture with an existing model in vLLM.
However, for models that include new operators (e.g., a new attention mechanism), the process can be a bit more complex.

.. tip::
If you are encountering issues while integrating your model into vLLM, feel free to open an issue on our `GitHub <https://github.com/vllm-project/vllm/issues>`_ repository.
We will be happy to help you out!
Copy link
Member

Choose a reason for hiding this comment

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

Maybe keep some of this?

Copy link
Member Author

Choose a reason for hiding this comment

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

I've already linked users to the base "Adding a New Model" which includes the same content.

@DarkLight1337 DarkLight1337 merged commit 9389380 into vllm-project:main Jul 6, 2024
70 checks passed
@DarkLight1337 DarkLight1337 deleted the clean-docs branch July 6, 2024 09:19
Alvant pushed a commit to compressa-ai/vllm that referenced this pull request Oct 26, 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