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 22, 2016 · 13 revisions
  1. 每个教程文件夹的目录结构如下:

    • data:存放下载的数据、模型,以及下载脚本。预处理后的数据(可选)也放在该文件夹。
    • image:存放图片。图片需大小适中,img/png格式,且命名不能采用1.img等无法说明该图内容的方式。
    • README.md:中文教程。
    • src:存放模型配置.py,训练和预测脚本.sh,预处理脚本(可选)等。注意:上传的.sh文件必须为可执行文件。
  2. 每个中文README.md的小标题:

    • 背景介绍:包括历史回顾和问题定义。
    • 效果展示:即效果示例图(该小节可选)。
    • 模型概览:介绍该教程涉及到的模型,包括对应的公式(不需要推导过程)和模型展示图。
    • 数据准备:介绍数据集,以及如何进行预处理。
    • 训练模型:在Paddle上是怎样训练模型的。
      • 模型配置说明:根据模型概览,对应说明配置内容。
      • 训练命令及结果
    • 应用模型:在Paddle上是怎样应用模型的。
    • 总结
    • 参考文献:使用谷歌学术搜索中的GB/T 7714格式。
  3. 格式要求(md格式):

  4. 已有参考:文档目录代码目录