Ver código fonte

Updated documentation

Efren Yevale Varela 1 semana atrás
pai
commit
81e29f63b4
2 arquivos alterados com 19 adições e 1 exclusões
  1. 16 1
      README.md
  2. 3 0
      docs/CLI.md

+ 16 - 1
README.md

@@ -76,6 +76,20 @@ uv sync --extra triage
 uv sync --extra speaker
 ```
 
+### AMD / ROCm hosts
+
+`uv sync` installs the CUDA CTranslate2 wheel, which loads fine on a ROCm machine but silently
+runs on CPU. After the last sync, install the ROCm stack:
+
+```bash
+scripts/install-rocm.sh
+```
+
+Any later `uv sync` **or plain `uv run`** (it syncs implicitly) puts the CUDA wheels back. Once the
+ROCm stack is in place, launch with `.venv/bin/stt-daemon ...` or `uv run --no-sync ...`, and run
+tests with `.venv/bin/python -m pytest`. See
+[docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md#gpu-on-amd--rocm).
+
 The `triage` extra is opt-in: the default sync does not install Laya, and the test suite stays green without it.
 
 The `speaker` extra is likewise opt-in and **off by default**. To enable speaker identification,
@@ -127,7 +141,7 @@ Then launch the whole system with one command:
 uv run stt-daemon up --with-tui
 ```
 
-That supervises the daemon, the assistant, and the TUI together; quitting the TUI stops everything cleanly. The manual flow is the same three steps without the supervisor:
+That supervises the daemon, the assistant, and the TUI together; quitting the TUI stops everything cleanly. On an AMD/ROCm host, use `.venv/bin/stt-daemon up --with-tui` instead — see [AMD / ROCm hosts](#amd--rocm-hosts). The manual flow is the same three steps without the supervisor:
 
 ```bash
 uv run stt-daemon setup       # create the virtual sink (interactive picker)
@@ -156,6 +170,7 @@ Run the full suite with no audio hardware or live LLM required:
 
 ```bash
 uv run pytest -v
+# On an AMD/ROCm host, use `.venv/bin/python -m pytest -v` so the ROCm wheels are not reverted.
 ```
 
 See [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) for what the tests cover.

+ 3 - 0
docs/CLI.md

@@ -1,5 +1,8 @@
 # CLI Reference
 
+> On AMD/ROCm hosts after `scripts/install-rocm.sh`, use `.venv/bin/stt-daemon` or
+> `uv run --no-sync stt-daemon`. A plain `uv run` re-syncs the venv and reverts the ROCm wheels.
+
 The `stt-daemon` CLI provisions the virtual sink, runs the daemon, and lists devices. Every subcommand accepts the common overrides `--config`, `--device`, `--backend`, `--model`, `--language`, and `-v/--verbose`.
 
 ## Subcommands