docs: fix broken offline inference paths in documentation#37998
Merged
DarkLight1337 merged 5 commits intovllm-project:mainfrom Mar 24, 2026
Merged
docs: fix broken offline inference paths in documentation#37998DarkLight1337 merged 5 commits intovllm-project:mainfrom
DarkLight1337 merged 5 commits intovllm-project:mainfrom
Conversation
Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com>
|
Documentation preview: https://vllm--37998.org.readthedocs.build/en/37998/ |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request correctly updates numerous documentation files to reflect the new examples/basic/offline_inference/ directory structure. The changes are consistent and address the broken links mentioned in the description. However, I found two instances where the path update seems to have been applied incorrectly, resulting in a duplicated basic directory in the path. These appear to be oversights from an automated search-and-replace and should be corrected to ensure all links are valid.
|
👋 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. 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 If you have any questions, please reach out to us on Slack at https://slack.vllm.ai. 🚀 |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com>
docs/cli/README.md
Outdated
| ```bash | ||
| vllm run-batch \ | ||
| -i https://raw.githubusercontent.com/vllm-project/vllm/main/examples/offline_inference/openai_batch/openai_example_batch.jsonl \ | ||
| -i https://raw.githubusercontent.com/vllm-project/vllm/main/examples/basic/offline_inference/openai_batch/openai_example_batch.jsonl \ |
Member
There was a problem hiding this comment.
Member
There was a problem hiding this comment.
Please check the other files one by one as well
Contributor
Author
There was a problem hiding this comment.
Hi @DarkLight1337 ,
I've refined this PR and reduced the scope to the 2 files where the broken paths were manually verified.
Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com>
vineetatiwari27
force-pushed
the
docs/fix-broken-example-paths
branch
2 times, most recently
from
704733b to
415493d
Compare
Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com>
vineetatiwari27
force-pushed
the
docs/fix-broken-example-paths
branch
from
415493d to
3c9f2cd
Compare
DarkLight1337
added
the
ready
RhizoNymph
pushed a commit
to RhizoNymph/vllm
that referenced
this pull request
Mar 26, 2026
…ct#37998) Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com> Co-authored-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
HenryTangDev
pushed a commit
to HenryTangMain/vllm
that referenced
this pull request
Mar 27, 2026
…ct#37998) Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com> Co-authored-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
malaiwah
pushed a commit
to malaiwah/vllm
that referenced
this pull request
Mar 27, 2026
…ct#37998) Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com> Co-authored-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Michel Belleau <michel.belleau@malaiwah.com>
khairulkabir1661
pushed a commit
to khairulkabir1661/vllm
that referenced
this pull request
Mar 27, 2026
…ct#37998) Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com> Co-authored-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Monishver11
pushed a commit
to Monishver11/vllm
that referenced
this pull request
Mar 27, 2026
…ct#37998) Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com> Co-authored-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Monishver Chandrasekaran <monishverchandrasekaran@gmail.com>
nithinvc
pushed a commit
to nithinvc/vllm
that referenced
this pull request
Mar 27, 2026
…ct#37998) Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com> Co-authored-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Nithin Chalapathi <nithin.ch10@gmail.com>
JiantaoXu
pushed a commit
to JiantaoXu/vllm
that referenced
this pull request
Mar 28, 2026
…ct#37998) Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com> Co-authored-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
vrdn-23
pushed a commit
to vrdn-23/vllm
that referenced
this pull request
Mar 30, 2026
…ct#37998) Signed-off-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Signed-off-by: Vineeta Tiwari <vineetatiwari2000@gmail.com> Co-authored-by: Vineeta Tiwari <vineeta.tiwari2@ibm.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Vinay Damodaran <vrdn@hey.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
A manual audit of the documentation revealed that specific files in docs/models/pooling_models/ were using incorrect relative paths to reach the examples/ directory. Additionally, these files referenced a directory structure (examples/offline_inference/basic/) that did not match the actual repository layout.
Changes
Testing
ls docs/models/pooling_models/../../../examples/basic/offline_inference/classify.py