用途:在更新 anomalib 模型文档、基准表格、示例结果图片或文档参考页面时使用,保持模型 README、docs 页面、图片与基准/示例引用对齐。当 README 变更但对应 docs 页面未更新、图片引用指向缺失资源、基准表格与已提交产物不符、或示例结果暗示仓库并不包含的覆盖范围时,应请求变更。
需要对齐的表面:src/anomalib/models//README.md、docs/source/markdown/guides/reference/models/、docs/source/images/**、results/ 下的基准与运行产物。模型 README 通常在 src/anomalib/models/image/<model>/README.md 或 video/<model>/README.md,另有分类级 README。文档页通常在 docs/source/markdown/guides/reference/models/image 或 video/<model>.md,并保持 index.md 最新。图片资产通常在 docs/source/images/<model>/,常见 architecture.* 与 results/0.png 等,部分模型命名不标准如 cs_flow。
必要流程:先检查再编辑,读取 README、对应 docs 页、图片目录,检查 results/ 是否已有实测产物及引用图片是否有效;README 与 docs 同时存在时不可只改一个。保持标题、描述、架构与图片引用、用法、基准、示例结果、TODO 等章节同步。基准更新优先使用仓库既有流程 tools/experimental/benchmarking/,只用实测结果,从 results/ 已提交产物取值,不得编造平均值或分数;基准未完成时明确说明,仅填有支持的值。示例图片只能来自完成模型输出,避免损坏、空掩码或占位图,不足三张有效样例时用明确 TODO 代替坏链接。README 图片引用优先与仓库一致的 /docs/source/images/<model>/... 形式。
验证与限制:完成前确认 README 与 docs 对基准和示例状态一致、所有图片路径存在、基准表与提交产物一致、TODO 准确具体、辅助脚本保持窄范围且针对模型。已知陷阱包括 csflow 与 cs_flow 路径差异、部分模型缺少三张样例图、results/ 有产物但文档未同步、图片路径可解析时文档仍漂移。需一并检查 README、docs 与图片资源;基准值必须来自已提交实测产物;缺失资产应显式说明而非坏链接;注意模型命名特例需手动核对路径。