Skip to content

docs: README for the 0.2.0 images - #18

Merged
planetf1 merged 6 commits into
mainfrom
docs/readme-release-0.2.0
Oct 27, 2026
Merged

planetf1 merged 6 commits into
mainfrom
docs/readme-release-0.2.0

Conversation

@planetf1

Copy link
Copy Markdown
Collaborator

The README now matches the published 0.2.0 images and says plainly what this project is.

  • Two plugins. Serving a Switch model needs the standard granite-switch plugin and this one, which adds the decision endpoints. The intro now says so, and links the 8b and 30b models on Hugging Face.
  • Which image to pull. A short table explains latest / 0.2.0 (decisions and chat) and latest-asr / 0.2.0-asr (speech model built in, because the images run with the Hub offline).
  • Base image and security. States the vLLM base image and asks readers to check any image they run, or build their own.
  • Upstream status is shorter: this project is temporary, vLLM is adding its own endpoints, and it stops at startup on a vLLM that has them.
  • Smaller fixes. request_id is accepted and ignored (it was listed as a default-only field). "How well tested" is two sentences, and Development lists the check scripts. The private-package notes are gone.

Docs only. I checked the request-option claims against plugin.py; the Hugging Face links return 200.

…image, upstream status

Assisted-by: Claude Code
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Assisted-by: Claude Code
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Assisted-by: Claude Code
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
…sion Index notes

Assisted-by: Claude Code
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Assisted-by: Claude Code
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
…ments

Assisted-by: Claude Code
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
@planetf1
planetf1 marked this pull request as ready for review October 27, 2026 10:12
@planetf1
planetf1 merged commit 48a1173 into main Oct 27, 2026
3 checks passed
@planetf1
planetf1 deleted the docs/readme-release-0.2.0 branch October 27, 2026 10:12
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.

1 participant