README.md 4.61 KB

ACR Docs Overview

更新:2026-06-02

一页结论

当前文档入口过多,现统一浓缩为 5 组主文档

  1. 项目与架构
  2. 数据与评测
  3. 业务数据接入
  4. 服务与工程
  5. 研究与路线

建议先只读这 5 组,不必一次看完全部细节文档。


1. 文档导航图

flowchart TD
    A[Docs Entry] --> B[Project Responsibility]
    A --> C[Architecture]
    A --> D[Dataset Spec]
    A --> E[Business Export Chain]
    A --> F[Service API]
    A --> G[Industrial Benchmark]
    A --> H[Industrialization Roadmap]
    A --> I[Licensing & Sources]
    A --> J[SOTA Research]

    B --> C
    C --> D
    D --> E
    E --> F
    G --> H
    I --> H
    J --> H

2. 浓缩阅读入口

读者角色 建议先读
新成员 项目与架构, 系统架构
算法/模型 数据规范, SOTA 调研
平台/后端 服务接口, 评测规范
数据接入 开放数据工作流, 业务导出 Cookbook
负责人/规划 工业化路线, 交接文档

2.5 新 session 最短阅读顺序

如果是新 session 接手,建议直接按这个顺序:

  1. 持续开发交接文档
  2. 更新记录
  3. 业务导出 Cookbook开放数据工作流

选择规则:

  • 做你们自己的业务素材接入:先读 business-export-cookbook.md
  • 做 FMA / MTG-Jamendo 这类开放数据:先读 open-dataset-workflow.md

2.6 新 session 最短可跑命令

如果你只是想先确认“业务导出链还能不能跑”,直接执行:

cd /workspace/acr-engine
/usr/local/miniconda3/bin/python scripts/business_export_offline_smoke.py \
  --output-root /tmp/business_export_offline_smoke

预期结果:

  • 生成业务导出样例
  • 生成 manifest-ready JSONL
  • 生成项目 catalog/train/test/val
  • train.py --dry-run 通过

3. 主文档分组

A. 项目与架构

B. 数据与评测

快速落地入口:

C. 业务数据接入

业务数据最短链:

  1. 业务导出 Cookbook
  2. acr-engine/scripts/normalize_business_export.py
  3. acr-engine/scripts/split_business_manifest_ready.py
  4. acr-engine/scripts/build_business_project_manifests.py
  5. acr-engine/scripts/business_export_offline_smoke.py

D. 服务与工程

E. 研究与路线


4. 文字说明

现在开始减少“同层重复文档”的阅读成本:

  • 先从入口页做分组
  • 再在每组里保留 1~3 份主文档
  • 次级细节尽量放到组内,而不是继续横向扩张文件数量

5. 细节附录

建议使用方式:

Sources

  • This file is an internal documentation navigation artifact for the current repo state.