Skip to content

[Doc] Enhance documentation around CPU container images#32286

Merged
bigPYJ1151 merged 1 commit intovllm-project:mainfrom
nathan-weinberg:cpu-docs
Jan 30, 2026
Merged

[Doc] Enhance documentation around CPU container images#32286
bigPYJ1151 merged 1 commit intovllm-project:mainfrom
nathan-weinberg:cpu-docs

Conversation

@nathan-weinberg
Copy link
Copy Markdown
Contributor

@nathan-weinberg nathan-weinberg commented Jan 13, 2026

Supercedes #31749

Adds a bit more detail around building and pulling CPU container images


Essential Elements of an Effective PR Description Checklist
  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft in the Google Doc.

@mergify
Copy link
Copy Markdown

mergify bot commented Jan 13, 2026

Documentation preview: https://vllm--32286.org.readthedocs.build/en/32286/

@mergify mergify bot added documentation Improvements or additions to documentation cpu Related to CPU backends labels Jan 13, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request enhances the documentation for CPU container images by adding instructions for building a CPU-only image and pulling pre-built CPU images. The changes are clear and helpful. I've found one minor issue in the provided build command example where an irrelevant build argument is mentioned, which could confuse users. I've suggested its removal.

Copy link
Copy Markdown
Contributor

@fadara01 fadara01 left a comment

Choose a reason for hiding this comment

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

Great docs improvement!

Please see my comments and add Arm related docs/info where relevant, similar to what you do for x86

@nathan-weinberg
Copy link
Copy Markdown
Contributor Author

@fadara01 updated based on your comments, but we can continue to hold this #32032 merges and then I will update the various links to point at Docker Hub rather than the ECR endpoint

Copy link
Copy Markdown
Contributor

@fadara01 fadara01 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@nathan-weinberg nathan-weinberg force-pushed the cpu-docs branch 3 times, most recently from c9013ca to 3de6403 Compare January 19, 2026 14:15
@bigPYJ1151 bigPYJ1151 self-assigned this Jan 21, 2026
@nathan-weinberg nathan-weinberg force-pushed the cpu-docs branch 2 times, most recently from 5d64ef3 to d999e62 Compare January 27, 2026 17:55
@mergify
Copy link
Copy Markdown

mergify bot commented Jan 27, 2026

Hi @nathan-weinberg, the pre-commit checks have failed. Please run:

uv pip install pre-commit
pre-commit install
pre-commit run --all-files

Then, commit the changes and push to your branch.

For future commits, pre-commit will run automatically on changed files before each commit.

Tip

Is mypy or markdownlint failing?
mypy and markdownlint are run differently in CI. If the failure is related to either of these checks, please use the following commands to run them locally:
# For mypy (substitute "3.10" with the failing version if needed)
pre-commit run --hook-stage manual mypy-3.10
# For markdownlint
pre-commit run --hook-stage manual markdownlint

@nathan-weinberg nathan-weinberg force-pushed the cpu-docs branch 2 times, most recently from 5078146 to 4eb4a86 Compare January 28, 2026 15:24
Copy link
Copy Markdown
Contributor

@fadara01 fadara01 left a comment

Choose a reason for hiding this comment

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

LGTM, just a minor comment for clarity and my own learning

@nathan-weinberg nathan-weinberg force-pushed the cpu-docs branch 3 times, most recently from 9b74abb to 3601a9d Compare January 29, 2026 19:04
Adds a bit more detail around building and pulling
CPU container images

Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
@bigPYJ1151 bigPYJ1151 enabled auto-merge (squash) January 30, 2026 13:32
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jan 30, 2026
@bigPYJ1151 bigPYJ1151 merged commit 58cb55e into vllm-project:main Jan 30, 2026
9 checks passed
@nathan-weinberg nathan-weinberg deleted the cpu-docs branch January 30, 2026 13:58
PiratePai pushed a commit to PiratePai/epd_shm that referenced this pull request Feb 3, 2026
…#32286)

Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
Signed-off-by: Pai <416932041@qq.com>
ItzDEXX pushed a commit to ItzDEXX/vllm that referenced this pull request Feb 19, 2026
…#32286)

Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cpu Related to CPU backends documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants