Skip to content

[Doc] Move multimodal Embedding API example to Online Serving page #14017

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Feb 28, 2025
Merged

[Doc] Move multimodal Embedding API example to Online Serving page #14017

merged 1 commit into from
Feb 28, 2025

Conversation

DarkLight1337
Copy link
Member

@DarkLight1337 DarkLight1337 commented Feb 28, 2025 •
edited by github-actions bot
Loading

The Multimodal Inputs page currently lists Embedding API with Embedding Inputs which is confusing. To resolve this, this PR moves Embedding API documentation to Online Serving.

Embedding Inputs will be implemented later by #13955

@DarkLight1337 DarkLight1337 added the ready ONLY add when PR is ready to merge/full CI is needed label Feb 28, 2025
@github-actions GitHub Actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Feb 28, 2025
DarkLight1337
DarkLight1337 commented Feb 28, 2025
View reviewed changes
vllm/model_executor/models/registry.py
Comment on lines +372 to +373
elif isinstance(model_cls, type) and (is_in_doc_build() or issubclass(
model_cls, nn.Module)):
Copy link
Member Author

@DarkLight1337 DarkLight1337 Feb 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Doc build fails locally without this guard, possibly due to mocking PyTorch imports

@DarkLight1337 DarkLight1337 changed the title [Doc] Move Embedding API example to Online Serving page [Doc] Move multimodal Embedding API example to Online Serving page Feb 28, 2025
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) February 28, 2025 05:41
@DarkLight1337 DarkLight1337 merged commit 1088f06 into vllm-project:main Feb 28, 2025
41 of 42 checks passed
@DarkLight1337 DarkLight1337 deleted the move-embedding-api-example branch February 28, 2025 07:23
@DarkLight1337 DarkLight1337 mentioned this pull request Feb 28, 2025
Merged
Akshat-Tripathi pushed a commit to krai/vllm that referenced this pull request Mar 3, 2025
@DarkLight1337 @Akshat-Tripathi
[Doc] Move multimodal Embedding API example to Online Serving page (v…
f00446b 
…llm-project#14017)

Signed-off-by: DarkLight1337 <[email protected]>
lulmer pushed a commit to lulmer/vllm that referenced this pull request Apr 7, 2025
@DarkLight1337 @lulmer
[Doc] Move multimodal Embedding API example to Online Serving page (v…
01c5d36 
…llm-project#14017)

Signed-off-by: DarkLight1337 <[email protected]>
Signed-off-by: Louis Ulmer <[email protected]>
@ckhordiasma ckhordiasma mentioned this pull request Apr 17, 2025
Closed
shreyankg pushed a commit to shreyankg/vllm that referenced this pull request May 3, 2025
@DarkLight1337 @shreyankg
[Doc] Move multimodal Embedding API example to Online Serving page (v…
16e9a13 
…llm-project#14017)

Signed-off-by: DarkLight1337 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Isotr0py Isotr0py Isotr0py approved these changes

@ywang96 ywang96 Awaiting requested review from ywang96

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@DarkLight1337 @Isotr0py