Add a first-run checklist for future sessions
Constraint: New sessions need a minimal startup checklist so they can verify repo health and resume development quickly Rejected: Keep startup knowledge implicit in long docs only | Increases ramp-up time and the chance of missing key checks Confidence: high Scope-risk: narrow Directive: Update this checklist whenever the default startup workflow or open-dataset commands materially change Tested: existence checks for acr-engine/FIRST_RUN_CHECKLIST.md, docs/README.md, docs/session-handoff.md, plus docs link-presence checks Not-tested: Human walkthrough of the full checklist from a fresh shell
Showing
4 changed files
with
48 additions
and
0 deletions
acr-engine/FIRST_RUN_CHECKLIST.md
0 → 100644
| 1 | # First Run Checklist | ||
| 2 | |||
| 3 | Use this checklist when a new session starts working on the repo. | ||
| 4 | |||
| 5 | ## 1. Read docs | ||
| 6 | - `docs/README.md` | ||
| 7 | - `docs/open-dataset-workflow.md` | ||
| 8 | - `docs/session-handoff.md` | ||
| 9 | |||
| 10 | ## 2. Verify repo health | ||
| 11 | ```bash | ||
| 12 | git status --short | ||
| 13 | ``` | ||
| 14 | |||
| 15 | ## 3. Verify open-dataset tooling | ||
| 16 | ```bash | ||
| 17 | /usr/local/miniconda3/bin/python -m py_compile src/data/external_adapters.py src/data/manifest_tools.py train.py run_demo.py evaluate.py | ||
| 18 | ``` | ||
| 19 | |||
| 20 | ## 4. Verify drop zones | ||
| 21 | - `data/raw/fma_small_audio/` | ||
| 22 | - `data/raw/mtg_jamendo_audio/` | ||
| 23 | |||
| 24 | ## 5. If real local audio exists, run smoke | ||
| 25 | ```bash | ||
| 26 | /usr/local/miniconda3/bin/python src/data/external_adapters.py smoke-local fma data/raw/fma_small_audio --output-root data/external_smoke --eval-ratio 0.2 --query-duration 8.0 --train-epochs 1 --batch-size 2 | ||
| 27 | ``` | ||
| 28 | |||
| 29 | ## 6. If real local audio does not exist | ||
| 30 | - continue using synthetic stand-ins | ||
| 31 | - or continue improving ingestion/benchmark/documentation paths |
| ... | @@ -164,6 +164,21 @@ | ... | @@ -164,6 +164,21 @@ |
| 164 | - 现在真实开放数据只需要放进明确目录即可 | 164 | - 现在真实开放数据只需要放进明确目录即可 |
| 165 | - 后续替换真实 FMA / MTG-Jamendo 本地音频时无需再猜目录结构 | 165 | - 后续替换真实 FMA / MTG-Jamendo 本地音频时无需再猜目录结构 |
| 166 | 166 | ||
| 167 | ### Stage: 新 session 首次启动清单 | ||
| 168 | |||
| 169 | 完成项: | ||
| 170 | - 新增 [acr-engine/FIRST_RUN_CHECKLIST.md](../acr-engine/FIRST_RUN_CHECKLIST.md) | ||
| 171 | - 把最常用启动检查命令与读文档顺序固化到 repo | ||
| 172 | - 将 checklist 接入 [docs/README.md](./README.md) 与 [docs/session-handoff.md](./session-handoff.md) | ||
| 173 | |||
| 174 | 验证结果: | ||
| 175 | - `FIRST_RUN_CHECKLIST.md` 已创建 | ||
| 176 | - docs 入口已挂接 checklist | ||
| 177 | |||
| 178 | 结论: | ||
| 179 | - 新 session 现在可以更快进入有效开发状态 | ||
| 180 | - 启动成本和漏看关键文档/命令的风险进一步下降 | ||
| 181 | |||
| 167 | ### Stage: confused 定向优化 v6(sample-level weighting) | 182 | ### Stage: confused 定向优化 v6(sample-level weighting) |
| 168 | 183 | ||
| 169 | 完成项: | 184 | 完成项: | ... | ... |
| ... | @@ -70,6 +70,7 @@ flowchart TD | ... | @@ -70,6 +70,7 @@ flowchart TD |
| 70 | ### C. 服务与工程 | 70 | ### C. 服务与工程 |
| 71 | - [服务接口](./service-api.md) | 71 | - [服务接口](./service-api.md) |
| 72 | - [持续开发交接文档](./session-handoff.md) | 72 | - [持续开发交接文档](./session-handoff.md) |
| 73 | - [首次启动检查清单](../acr-engine/FIRST_RUN_CHECKLIST.md) | ||
| 73 | - [更新记录](./CHANGELOG.md) | 74 | - [更新记录](./CHANGELOG.md) |
| 74 | 75 | ||
| 75 | ### D. 研究与路线 | 76 | ### D. 研究与路线 | ... | ... |
| ... | @@ -274,6 +274,7 @@ | ... | @@ -274,6 +274,7 @@ |
| 274 | - [docs/README.md](./README.md) | 274 | - [docs/README.md](./README.md) |
| 275 | - [docs/open-dataset-workflow.md](./open-dataset-workflow.md) | 275 | - [docs/open-dataset-workflow.md](./open-dataset-workflow.md) |
| 276 | - [docs/session-handoff.md](./session-handoff.md) | 276 | - [docs/session-handoff.md](./session-handoff.md) |
| 277 | - [acr-engine/FIRST_RUN_CHECKLIST.md](../acr-engine/FIRST_RUN_CHECKLIST.md) | ||
| 277 | 278 | ||
| 278 | 2. 检查真实数据是否已落位: | 279 | 2. 检查真实数据是否已落位: |
| 279 | - `acr-engine/data/raw/fma_small_audio/` | 280 | - `acr-engine/data/raw/fma_small_audio/` | ... | ... |
-
Please register or sign in to post a comment