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.

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

[Doc] Group examples into categories #11782

Merged
merged 21 commits into from
Jan 8, 2025
Merged

[Doc] Group examples into categories #11782

merged 21 commits into from
Jan 8, 2025
+240 −62

Conversation

hmellor
Copy link
Collaborator

@hmellor hmellor commented Jan 6, 2025 •
edited by github-actions bot
Loading

Implements suggestion from #11645 (comment)

  • Creates three categories: Online Inference, Offline Inference, Other
  • Nests categories inside Examples to reduce space consumed in the sidebar
  • Add description to each index page (Examples, Online Inference, Offline Inference, Other)
  • Add missing capitalisation fixes
  • Add missing .md and multi-file examples

Currently no examples have been categorised, this will happen in a follow up PR which organises the examples into category directories.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 6, 2025

👋 Hi! Thank you for contributing to the vLLM project.
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 do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Jan 6, 2025
@mergify Mergify
Copy link

mergify bot commented Jan 6, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @hmellor.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Jan 6, 2025
@hmellor hmellor requested a review from DarkLight1337 January 6, 2025 22:37
@hmellor hmellor force-pushed the categorise-examples branch from d379d7e to 7943903 Compare January 6, 2025 22:59
@mergify mergify bot removed the needs-rebase label Jan 6, 2025
@hmellor hmellor force-pushed the categorise-examples branch from 6bd6e71 to 6f18c4a Compare January 6, 2025 23:13
@hmellor
Copy link
Collaborator Author

hmellor commented Jan 6, 2025

CI Docs build

hmellor added 18 commits January 7, 2025 14:18
@hmellor
Ignore all files in docs/source/getting_started/examples
50f9d3a 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Fix skipped heading level in prometheus/grafana tutorial
c163f89 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Fix code block hinting in FP8 tutorial
5936229 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Add colon_fence and sphinx-togglebutton
ff4504b 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Update generate_examples.py
008e69a 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Add missing OpenAI batch example
a72bff3 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Make typing Python 3.8 compatible for RTD
929adac 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Example source -> Example materials
5c57a53 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Make linter happy
f0025d8 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Delete md template
ea22d7a 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Fix error with chart-helm
6538bd8 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Revert "Make typing Python 3.8 compatible for RTD"
b01b7c8 
This reverts commit 66763fa.

Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Make Python 3.12 linter happy
328f3e6 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Split mixed example
71ce031 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Categorise based on directory
92d6abf 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Make linter happy
3853007 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
syntax error
6c852a8 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor
Put categorised examples first
141bfbc 
Signed-off-by: Harry Mellor <[email protected]>
@hmellor hmellor force-pushed the categorise-examples branch from 2149016 to 141bfbc Compare January 7, 2025 14:18
DarkLight1337
DarkLight1337 reviewed Jan 7, 2025
View reviewed changes
docs/Makefile Outdated Show resolved Hide resolved
DarkLight1337
DarkLight1337 approved these changes Jan 7, 2025
View reviewed changes
Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for cleaning this up!

@DarkLight1337 DarkLight1337 changed the title Group examples into categories [Doc] Group examples into categories Jan 7, 2025
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) January 7, 2025 15:24
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jan 7, 2025
auto-merge was automatically disabled January 7, 2025 15:25

Head branch was pushed to by a user without write access

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) January 7, 2025 15:32
mgoin
mgoin approved these changes Jan 7, 2025
View reviewed changes
Copy link
Member

@mgoin mgoin left a comment

Choose a reason for hiding this comment

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

Looks very clean!

@hmellor
Copy link
Collaborator Author

hmellor commented Jan 7, 2025

Looks like the only failure is the TPU tests, which should be unrelated

@youkaichao youkaichao disabled auto-merge January 8, 2025 01:20
@youkaichao youkaichao merged commit 5950f55 into vllm-project:main Jan 8, 2025
35 of 37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DarkLight1337 DarkLight1337 DarkLight1337 approved these changes

@mgoin mgoin mgoin approved these changes

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.
4 participants
@hmellor @mgoin @DarkLight1337 @youkaichao