Content-Length: 472998 | pFad | http://github.com/vllm-project/vllm-spyre/pull/161

D8 📝 docs for local development on CPU by prashantgupta24 · Pull Request #161 · vllm-project/vllm-spyre · GitHub
Skip to content

📝 docs for local development on CPU #161

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

Merged
merged 23 commits into from
May 23, 2025
Merged

📝 docs for local development on CPU #161

merged 23 commits into from
May 23, 2025

Conversation

prashantgupta24
Copy link
Collaborator

@prashantgupta24 prashantgupta24 commented May 15, 2025

Add documentation on how to run the eager (CPU) examples + tests on arm64 and x86_64.

See it live - https://vllm-spyre--161.org.readthedocs.build/en/161/getting_started/local_development.html

Will wait for #159 to merge first

Copy link

👋 Hi! Thank you for contributing to vLLM support on Spyre.
Just a reminder: Make sure that your code passes all the linting checks, otherwise your PR won't be able to be merged. To do so, first install the linting requirements, then run format.sh and commit the changes. This can be done with uv directly:

uv sync --frozen --group lint

Or this can be done with pip:

uv pip compile --group lint > requirements-lint.txt
pip install -r requirements-lint.txt
bash format.sh

Now you are good to go 🚀

@prashantgupta24 prashantgupta24 changed the title 📝 add documentation for local m1 testing 📝 add documentation for running unit tests on an m1 May 16, 2025
@prashantgupta24 prashantgupta24 changed the title 📝 add documentation for running unit tests on an m1 📝 add documentation for running spyre examples + unit tests on an m1 May 16, 2025
@prashantgupta24 prashantgupta24 changed the title 📝 add documentation for running spyre examples + unit tests on an m1 📝 add documentation for local development on M1 May 16, 2025
@prashantgupta24 prashantgupta24 changed the title 📝 add documentation for local development on M1 📝 docs for local development on M1 May 16, 2025
@prashantgupta24 prashantgupta24 marked this pull request as ready for review May 16, 2025 22:12
Copy link
Collaborator

@rafvasq rafvasq left a comment

Choose a reason for hiding this comment

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

Overall, I think that this doc could get split up a bit. 🤔

  • For example, the installation part could be part of the general Installation doc but denoting that it's different way to install (for local dev on mac).

  • Running the tests could be a section in the Contributing guide. See https://docs.vllm.ai/en/stable/contributing/overview.html#developing for inspiration.

  • Running the examples are a bit straightforward and I'm not really sure they require extra documentation except maybe in a future quickstart doc or in the Contributing guide too?

@prashantgupta24
Copy link
Collaborator Author

prashantgupta24 commented May 19, 2025

Overall, I think that this doc could get split up a bit. 🤔

  • For example, the installation part could be part of the general Installation doc but denoting that it's different way to install (for local dev on mac).
  • Running the tests could be a section in the Contributing guide. See https://docs.vllm.ai/en/stable/contributing/overview.html#developing for inspiration.
  • Running the examples are a bit straightforward and I'm not really sure they require extra documentation except maybe in a future quickstart doc or in the Contributing guide too?

Thanks for the review Rafael!

  1. Yeah I was avoiding touching the installation.md file until you made your changes in your PR. I also don't understand the difference between installing spyre via uv sync (like in this PR) vs using uv pip install -e (like in installation.md). As far as I can tell, both are installing a local editable version of spyre in the venv. The additional advantage of using uv sync is that it also installs all the dev dependencies. If there's no difference, we can probably replace the installation.md content with what I have in local_development.md completely 🤷
  2. For the tests I agree they could be in the contributing section. Then we could eventually add other variations of running the tests, for example, on the CI or on a machine with an actual spyre card.
  3. The thing with examples is that there is some caveat of running the examples on a CPU (like setting the HF_HUB_OFFLINE variable) so that's why I had it in this section. Possibly I can move that in the quickstart doc and add a note. Or actually I can write a condition in the example files itself which checks for the current architecture and changes the variables accordingly 🤔

@prashantgupta24 prashantgupta24 changed the title 📝 docs for local development on M1 📝 docs for local development on CPU May 19, 2025
@prashantgupta24 prashantgupta24 force-pushed the docs-local-dev branch 2 times, most recently from b7b324e to bebeeb4 Compare May 19, 2025 22:03
@prashantgupta24 prashantgupta24 requested a review from rafvasq May 20, 2025 16:33
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Signed-off-by: Prashant Gupta <prashantgupta@us.ibm.com>
Copy link
Collaborator

@joerunde joerunde left a comment

Choose a reason for hiding this comment

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

let's get it 👍

@joerunde joerunde enabled auto-merge (squash) May 23, 2025 17:35
@github-actions github-actions bot added the ready label May 23, 2025
@joerunde joerunde merged commit 4bf2c8c into main May 23, 2025
20 checks passed
@joerunde joerunde deleted the docs-local-dev branch May 23, 2025 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants








ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/vllm-project/vllm-spyre/pull/161

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy