-
Notifications
You must be signed in to change notification settings - Fork 18
[docs] Add install from PyPI to docs #327
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
Conversation
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
👋 Hi! Thank you for contributing to vLLM support on Spyre.
Or this can be done with
Now you are good to go 🚀 |
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@joerunde @rafvasq -- should be good to review now 🙏🏻 Rendered changes: https://vllm-spyre--327.org.readthedocs.build/en/327/getting_started/installation.html Thank you! |
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
BadPluginError encountered while scanning 'docs/getting_started/installation.md': (45,1): Plugin id 'MD031' had a critical failure during the 'next_token' action. Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@@ -29,4 +29,4 @@ jobs: | |||
- name: Install dependencies | |||
run: uv sync --frozen --only-group lint | |||
- name: Lint docs | |||
run: tools/lint_docs.sh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tools/lint_docs.sh
runs both scan
and fix
-- but during a CI run, changing files to fix lint errors is not needed
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
inline comment (pyml disable-next-line code-block-style) broke tabbed rendering of installation options Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Sorry I got distracted after my first comment earlier- This is looking really good! |
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm!
Looks like maybe we've broken something about the test jobs, they're showing up as expected but not running :(
Are they supposed to run but skip all execution when there are only docs changes so the checks pass?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly nits around using admonitions to highlight certain notes and some typos -- but nothing worth blocking a merge :)
Because I touched |
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
Weird, the admonitions do not get rendered in the preview? @rafvasq ? e.g.: ![]() ... and expanded: ![]() |
@ckadner 🤔 Not sure what you mean since I see them there in the preview and your screenshot? |
Oh oh, this one auto-merged before @rafvasq could re-review since @joerunde had approved it already earlier but the PR hung around due to the missing required test runs. With the latest commit it triggered the tests again and all checks completed. I should have disabled auto-merge prior to pushing my review updates 😢 |
Update the install docs to include install from PyPI
https://vllm-spyre--327.org.readthedocs.build/en/327/getting_started/installation.html#install-vllm-with-the-vllm-spyre-plugin