docs: refresh docs to match the current state, add GUI/CLI/troubleshooting

The README still listed the settings UI as "todo" and its quick start told
users to download models into the working directory; phase 3 still described
the caption window's close button as "quit" and used the wrong binary name.
Bring the docs up to date and fill the gaps: a GUI guide (first run, settings
tabs, tray, download, verify), a full CLI option reference marking the
test-only flags, a troubleshooting page, the model registry's size/sha256
fields plus a licence/size table, the RTF measurement caveat (llama-cli 0.19
vs the in-process 0.56), and a note that the streaming-ONNX backend has its
own code path. phase0/phase1 experiment docs are marked as historical.

文档与现状对齐:README 的 Phase 4 从「待做」改为完成、快速开始不再让人把模型下到当前
目录;phase3 的 ✕ 说明改为「隐藏到托盘」、用法改用 live-caption;新增 GUI/CLI/排错三份
文档;asr-backends 补上注册表的 size/sha256 字段与模型许可/体积表;phase0 补上 RTF 口径
说明(llama-cli 的 0.19 与程序内的 0.56);phase2 补上「流式 ONNX 走另一条分支」的说明。
This commit is contained in:
blumia committed 2026-10-12 17:29:45 +08:00
1 parent 370c869ad0
commit d234b9658d
12 files changed
+512 -57

No files matched your search

+36 -6
View File
@@ -29,13 +29,44 @@ IAsr(src/core/iasr.h)
- 注册表:`data/models.json`(编译进二进制,同时也给脚本用)
- 存储位置:`~/.local/share/live-caption/models/<id>/`
(即 `QStandardPaths::GenericDataLocation + /live-caption/models`)
- 下载:`scripts/fetch-models.sh [id...]` / `--all`;已存在的文件会跳过
- 下载:GUI 的「模型 → 下载」,或 `scripts/fetch-models.sh [id...]` / `--all`;已存在的文件会跳过
```bash
./scripts/fetch-models.sh # 列出模型与安装状态
./scripts/fetch-models.sh zipformer-zh-2025
```
一条模型长这样:
```json
{
"id": "zipformer-zh-2025",
"name": "中文流式(k2-fsa 官方 2025-06-30)",
"backend": "sherpa-online", // llama-cpp | sherpa-online
"languages": ["zh"],
"license": "Apache-2.0",
"note": "167MB,最快最准的中文流式模型",
"files": {
"encoder": { "name": "encoder.int8.onnx", "url": "https://...", "size": 161000000, "sha256": "5ac5..." },
"tokens": { "name": "tokens.txt", "url": "https://...", "size": 3000, "sha256": "6193..." }
}
}
```
`size` / `sha256` 就是完整性校验的依据:**打开/选择模型时只比大小**(快),
「校验完整性」或 `--verify-model` 才**重算 sha256**(慢,但能发现内容损坏)。
## 模型清单
| id | 语言 | 后端 | 许可 | 体积 | sha256(首个文件,前 16 位) |
|---|---|---|---|---|---|
| `qwen3-asr-0.6b-q8` | 52 语言 | llama-cpp | Apache-2.0 | 1019MB | `bca259818b50ca7c…` |
| `zipformer-zh-2025` | zh | sherpa-online | Apache-2.0 | 167MB | `5ac51e27981bb4da…` |
| `xasr-zh-en-480` | zh, en | sherpa-online | Apache-2.0 | 615MB | `0c3454033d249081…` |
| `nemotron35-560ms` | 16 语言(含 ja) | sherpa-online | OpenMDW-1.1 | 682MB | `012e9321373af990…` |
分发包模型时记得带上许可(尤其 Nemotron 是 OpenMDW-1.1,不是 Apache-2.0)。
## 用法
```bash
@@ -65,14 +96,13 @@ IAsr(src/core/iasr.h)
## 设置对话框
三个页签(模型 / 显示 / 高级),底部三个按钮:
- **应用**:应用设置但**不关闭**对话框,方便实时预览(改不透明度、字号时会立刻看到效果);
- **取消**:放弃本次改动;
- **确定**:应用并关闭。
三个页签(模型 / 显示 / 高级),底部三个按钮 **应用 / 取消 / 确定** ——
「应用」= 应用但不关闭,方便实时预览(改不透明度、字号时会立刻看到效果)。
只有**模型 / 识别语言 / 采集设备**变化才会重启识别后端;透明度、字号、行数、位置这类外观改动是即时生效的,不会打断正在进行的转写。
各设置项的完整说明见 [gui.md](gui.md)。
## 采集设备选择
默认跟随系统默认输出;也可以在设置里指定某个输出设备(`--list-devices` 可列出):