Skip to content

Conversation

shirinyamani
Copy link
Member

@shirinyamani shirinyamani commented Apr 28, 2025

What does this PR do?

Document on vllm-integration

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a GitHub issue? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

Who can review?

Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

@shirinyamani shirinyamani changed the title Vllm doc final 📝 vLLM-integration documentation Apr 28, 2025
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@shirinyamani shirinyamani requested a review from lewtun April 28, 2025 16:16
@qgallouedec
Copy link
Member

The TOC doesn't render as expected, I think it's because you don't use the right heading levels
Screenshot 2025-04-28 at 12 35 22

@qgallouedec
Copy link
Member

It looks satisfactory on the whole. Can you proofread from start to finish to make sure there are no missing capitals, `, links etc.? I've seen these elements missing in several places.
I'll leave it to @lewtun or @edbeeching to conduct the rest of the reviews, as they'll probably have better advice than me on how to word things.

@shirinyamani
Copy link
Member Author

It looks satisfactory on the whole. Can you proofread from start to finish to make sure there are no missing capitals, `, links etc.? I've seen these elements missing in several places.
I'll leave it to @lewtun or @edbeeching to conduct the rest of the reviews, as they'll probably have better advice than me on how to word things.

@qgallouedec Okay I guess the rendering problem is resolved now + proofread✅

Screenshot 2025-04-28 at 2 35 40 PM

@shirinyamani shirinyamani requested a review from edbeeching April 28, 2025 20:43
Copy link
Member

@lewtun lewtun left a comment

Choose a reason for hiding this comment

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

Thanks for adding this nice guide @shirinyamani ! Overall it looks good with some small nits from my part :)

@shirinyamani shirinyamani merged commit 89d44ca into main May 6, 2025
2 checks passed
@shirinyamani shirinyamani deleted the vllm-doc-final branch May 6, 2025 15:37
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.

5 participants