Repository navigation
docs: add a quickstart from install to first chat reply #1071
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -6,15 +6,45 @@ SPDX-License-Identifier: MIT | |||||||||
|
|
||||||||||
| # Getting started with ROCm CLI | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As suggested in the comment on TOC, two headings are not required here. We can call this doc "Quickstart guide" or something similar. |
||||||||||
|
|
||||||||||
| ## Quickstart | ||||||||||
|
|
||||||||||
| <!-- Step 1 and the closing paragraph are deliberate copies of the README text, | ||||||||||
| with the cross-references retargeted to this site. The include between | ||||||||||
| them uses the end of README step 1 and the start of its closing paragraph | ||||||||||
| as anchors; edit both together. --> | ||||||||||
| This quickstart takes you from installing ROCm CLI to getting a chat reply from | ||||||||||
| a model served on your GPU. You need a computer with a supported AMD GPU running | ||||||||||
| Linux, WSL2, or Windows. The first run involves large downloads: | ||||||||||
| `rocm install sdk` fetches a ROCm runtime and a PyTorch stack, and `rocm serve` | ||||||||||
| fetches a model of a few GB. Allow extra time and disk space. | ||||||||||
|
|
||||||||||
| Follow these steps: | ||||||||||
|
|
||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| 1. Install ROCm CLI with the command for your platform in | ||||||||||
| [Installing ROCm CLI](install/installation.md). Then open a new terminal and | ||||||||||
| confirm that `rocm version` prints the CLI version. | ||||||||||
|
Comment on lines
+23
to
+25
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| ```{include} ../../README.md | ||||||||||
| :start-after: "`rocm version` prints the CLI version." | ||||||||||
| :end-before: "For other models and engine options, see" | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| For other models and engine options, see | ||||||||||
| [Configure ROCm and serve a model](#configure-rocm-and-serve-a-model) and | ||||||||||
| [Model serving](commands.md#model-serving). | ||||||||||
|
|
||||||||||
| The following recording shows the CLI inspecting the environment and chatting | ||||||||||
| with a locally served model: | ||||||||||
|
|
||||||||||
|  | ||||||||||
|
|
||||||||||
| ## First run | ||||||||||
|
|
||||||||||
| ```{include} ../../README.md | ||||||||||
| :start-after: "## First run" | ||||||||||
| :end-before: "## Interactive interfaces" | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
|  | ||||||||||
|
|
||||||||||
| ## Interactive interfaces | ||||||||||
|
|
||||||||||
| ```{include} ../../README.md | ||||||||||
|
|
||||||||||
Uh oh!
There was an error while loading. Please reload this page.