report-layout.md
1.13 KB
Report Layout Convention
一页结论
所有评测与发布产物统一放入:
reports/<model-version>/<data-version>/eval.jsonreports/<model-version>/<data-version>/benchmark-report.mdreports/<model-version>/<data-version>/model-card.mdreports/<model-version>/<data-version>/release-checklist.mdreports/<model-version>/<data-version>/artifact-manifest.json
1. 布局图
flowchart TD
A[reports/] --> B[model-version]
B --> C[data-version]
C --> D[eval.json]
C --> E[benchmark-report.md]
C --> F[model-card.md]
C --> G[release-checklist.md]
C --> H[artifact-manifest.json]
2. 约定表
| 文件 | 用途 |
|---|---|
| eval.json | 机器可读评测输出 |
| benchmark-report.md | 人类可读 benchmark 摘要 |
| model-card.md | 模型说明 |
| release-checklist.md | 发布门禁 |
| artifact-manifest.json | 产物索引 |
3. 文字说明
- 所有 release 候选都应有独立目录
- 不要把临时 smoke 文件与正式 release 报告混放
Sources
- docs/benchmark-report-template.md
- docs/model-card-template.md
- docs/release-checklist.md