Skip to content
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.

中文教程撰写统一标准

Tao Luo edited this page Dec 27, 2016 · 13 revisions
  1. 每个教程文件夹的目录结构如下:

    • data:存放下载的数据及其脚本。预处理后的数据(可选)和train.list等也放于此。
    • pretrained(可选):存放预训练好的模型,以及下载脚本。
    • image:存放图片。需大小适中,img/png格式,且命名不能采用1.img等无法说明该图内容的方式。图内文字最好是中文(不强求),其他网站/论文中合适的图片可以先截图,后续有设计师做统一修改。
    • README.md:中文教程。
    • 其他文件包括:模型配置.py,训练和预测脚本.sh,预处理脚本(可选)等。注意:上传的.sh文件必须为可执行文件。
    • .gitignore:请添加不需要git add的所有文件。
  2. 每个中文README.md的小标题:

    • 背景介绍:包括历史回顾和问题定义。
    • 效果展示:即效果示例图(该小节可选)。
    • 模型概览:介绍该教程涉及到的模型,包括对应的公式(不需要推导过程)和模型展示图。
    • 数据准备:子标题如下,其中两个可选。
      • 数据介绍与下载
      • 用户自定义数据集(可选):介绍如何组织用户自定义的数据集,该小节可选。
      • 数据预处理(可选)
      • 提供数据给PaddlePaddle:介绍dataprovider.py,需贴出代码。
    • 模型配置说明:训练模型/应用模型都写在一个配置(.py)中。下设三个子标题,需对应贴出代码。
      • 数据定义:介绍define_py_data_sources2的使用。
      • 算法配置:介绍settings的使用。
      • 模型结构:根据模型概览,详细介绍是如何配置的。
    • 训练模型:在Paddle上是怎样训练模型的,介绍训练命令及结果。模型输出统一设为model目录。
    • 应用模型:在Paddle上是怎样应用模型的,介绍应用命令及结果。
    • 总结
    • 参考文献:使用谷歌学术搜索中的GB/T 7714格式。
  3. 格式要求(md格式):

  4. 已有参考:Github Markdown常见问题如何贡献代码文档目录代码目录