Repository navigation
docs: add a quickstart from install to first chat reply - #1071
Conversation
|
Update: quickstart follow-ups (6860a13)
Docs-only change, so no scenario applies. Sphinx |
Add a Quickstart section to the README and the top of the Getting started page. It walks through rocm examine, rocm install sdk, rocm serve, and rocm chat, with a separate serve and chat command for each engine: the qwen alias is a GGUF model that only Lemonade serves, so Instinct GPUs on vLLM need a safetensors model. Also correct the Configure ROCm section, which said qwen serves out of the box on any GPU. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
6860a13 to
f3cc316
Compare
Name the quickstart on the landing card, show the two `rocm examine` lines the reader should look for, state the supported platforms and the size of the first download up front, show the form of the stop command, and put the CLI demo right after the quickstart. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
f3cc316 to
4e076c6
Compare
juhovainio
left a comment
There was a problem hiding this comment.
Looks good. I checked the quickstart's commands, flags and field names against the code (examine output, chat flags, --model matching, rocm services stop <id> --yes, the qwen alias) and they match; links follow the repo's relative-link rules and CI is green.
One small thing, left inline: the "about 2.5 GB" download size isn't backed by anything in the repo. Also worth a quick grep of docs/*.md and docs/manual-testing.md for leftover "qwen serves out of the box" wording. This reflects a read of the diff and the code, not a live run on a GPU.
| @@ -6,15 +6,43 @@ SPDX-License-Identifier: MIT | |||
|
|
|||
| # Getting started with ROCm CLI | |||
There was a problem hiding this comment.
As suggested in the comment on TOC, two headings are not required here. We can call this doc "Quickstart guide" or something similar.
Say "a few GB" for the first model download instead of a figure that isn't sourced in the repo, and cover both engines since the vLLM model is a different size. Reword the intro and add a lead-in before the numbered steps. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
Adds a Quickstart that takes a new user from installing ROCm CLI to a chat reply from a locally served model.
What changes
rocm examine,rocm install sdk,rocm serve,rocm chat, then stop the server. The site includes the README text, so there is one source.qwenalias resolves to a GGUF model that only Lemonade serves (Ryzen AI, Radeon). Instinct GPUs serve through vLLM, so the Quickstart usesQwen/Qwen2.5-1.5B-Instructthere. Readers pick their path from theeffective_default_engineline inrocm examine. vLLM isn't available on native Windows, so Windows always uses Lemonade.rocm chat --provider localwithout--modelonly matches the built-inqwenservice, so the vLLM path passes--model.qwenserves out of the box on any GPU.Testing
Sphinx docs build (-W), lychee link check and Read the Docs preview pass in CI.rocm examinefield names and theendpoint:/logs:/stop:lines in the deployment summary are checked against the CLI source.