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

中文教程撰写统一标准

schinger edited this page Dec 21, 2016 · 13 revisions
  1. 每个中文教程含有以下子目录:

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

    • 图片:大小适中,img/png格式,统一放置在当前目录的image文件夹下。命名不能采用1.img等无法说明该图内容的方式。
    • 公式:采用latex格式,分为$ 行内公式 $$$ 行间公式 $$等。具体请参阅markdown公式指导手册。让github支持公式显示的chrome插件GitHub with MathJax
    • function格式:文件名如dataprovider.py和代码中的函数名如forward采用该格式;层名如fc不采用该格式。
    • 参考文献:GB/T 7714格式请参阅具体步骤,同时在标题中加入文章链接。示例如:Bahdanau D, Cho K, Bengio Y. Neural machine translation by jointly learning to align and translate[J]. arXiv preprint arXiv:1409.0473, 2014.
  3. 已有参考:文档目录代码目录