Skip to content

docs: newcomer READMEs for the deployment and quantization modules - #24

Draft
vividf wants to merge 1 commit into
pr13-ptv3-onboardingfrom
pr14-module-readmes
Draft

docs: newcomer READMEs for the deployment and quantization modules#24
vividf wants to merge 1 commit into
pr13-ptv3-onboardingfrom
pr14-module-readmes

Conversation

@vividf

@vividf vividf commented Sep 5, 2026

Copy link
Copy Markdown
Owner

Stacked PR 15/15 — ⬅ #23

Stack(base pr-stack-base = 7e35d97):#11#12#13#14#15#16#17#18#19#20(CenterPoint 全功能點)→ #21#25#22#23#24(= 開發 branch HEAD,逐位元一致)。合併由下而上,每合一層把下一層 base retarget。

這個 PR 是什麼

兩份「第一次看這個 framework 的人」導向的模組 README——本 stack 全部設計決策與付過學費的教訓的正式落點:

  • deployment/README.md(新):三分鐘版(五步流程)、stage-graph 心智模型、三 backend 抽象、same-plan-everywhere 不變量、precision 自動路由表、island 規則手冊(誰進島 4 條、cast 放哪、每條規則違反的實測代價表、「島的 fp32 是記號不是執行精度」)、verification tolerance 哲學、evaluation 怎麼讀、新模型接入六步、檔案地圖、深挖連結。
  • quantization/README.md(重寫為 current-state):三分鐘版(dry_run→quantize→deploy)、宣告 vs 執行、PTQ/QAT workflow 與三個付費教訓(freeze_unquantized / 低 lr / PTQ-first)、INT8-vs-FP8 決策表(兩模型交叉驗證)、新增模型 checklist + 五個已付學費陷阱(各連 repo 內實例)、fp32-typed island 地基聲明;重構時代的診斷與 rename 表縮成歷史指標段。

Review 方式

對照代碼讀一遍;引用的檔名/路徑已逐一查證非死連結。內容主張(數字、機制)都有 work_dirs/reviews/ 的報告支撐——README 是入口,報告是證據。

檔案清單(點開)
autoware_ml/deployment/README.md 195 +++++++++++++++++++++++++++++++++++++
autoware_ml/quantization/README.md 160 ++++++++++++++++++++++++++++++

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant