Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 1.94 KB

File metadata and controls

41 lines (31 loc) · 1.94 KB

Leap-Code 工作区规范

为了保持工作区的整洁与高效协作,所有开发与评估工作必须遵循以下规范:

1. 目录结构规范

  • scripts/: 存放正式的脚本文件。
    • scripts/evaluation/: 评估核心逻辑 Python 脚本。
    • scripts/shell/: 存放各模型的评估启动脚本(.sh)。
    • scripts/tmp/: 存放开发过程中的临时脚本。
    • scripts/training/: 训练相关脚本。
    • scripts/utils/: 通用工具脚本。
  • logs/: 统一存放所有运行日志。
    • 评估日志建议命名:logs/eval_<model>_<dimension>_<date>.log
    • 训练日志建议命名:logs/train_<model>_<date>.log
  • results/: 统一存放所有评估结果。
    • 结构:results/<model_config>/<dimension>/
    • results/backup/: 存放历史或备份的评估结果。
  • eval.sh: 根目录下的统一评估入口脚本。
  • models/: 存放模型权重文件。
  • dataset/: 存放原始数据集。

2. 文件命名规范

  • 临时脚本/文件: 必须以 tmp_ 开头,严禁直接在根目录创建无前缀的临时文件。
  • 正式脚本: 使用小写字母加下划线(snake_case),如 run_vlm_evaluation.py

3. 日志与结果管理

  • 禁止乱拉屎: 严禁在根目录直接生成 .log.json.tar.gz.png 等文件。
  • 自动归档: 脚本应尽量支持将输出重定向或直接写入指定的 logs/results/ 目录。
  • 清理习惯: 任务完成后,应及时清理不再需要的 tmp_ 文件或将其移至专门的备份目录。

4. 开发流程规范

  • 分步执行: 复杂任务必须分步进行,每一步完成后需经确认再继续。
  • 定期汇报: 保持进度透明,禁止长时间静默工作。
  • Debug 限制: 针对同一问题的 Debug 次数超过 3 次仍未解决时,必须停止并报告,严禁盲目尝试。

最后更新时间:2025-12-26