sphinx_demo
latest
Contents:
1. 利用Sphinx生成项目文档
2.Jupyter Notebook案例
3.DEMO PROJECT API
4.代码规范
5.文档规范
README
模型及方法论证
性能测试及案例
Review记录
6. code review方案细则
Sphinx-DEMO
sphinx_demo
Docs
»
5.文档规范
Edit on GitHub
5.文档规范
¶
自动化文档生成请参展文档(1.2.3)查看,这里约定团队文档应包含内容。
README
¶
简介项目功能
安装方法
使用方法
模型及方法论证
¶
baseline方法
State-of-the-art模型、方法调研
选型模型、方法介绍,选型理由
性能测试及案例
¶
Jupyter Notebook文档
模型在测试集评估指标、计算性能
模型对比(与baseline、历史模型版本)
badcase和误差分析
Review记录
¶
review前,汇总期间更新模块、上次TODO跟进情况;
review后,本次TODO事项。