-
每个教程文件夹的目录结构如下:
- data:存放下载的数据、模型,以及下载脚本。预处理后的数据(可选)也放于此。
- image:存放图片。需大小适中,img/png格式,且命名不能采用1.img等无法说明该图内容的方式。
- README.md:中文教程。
- src:存放模型配置
.py
,训练和预测脚本.sh
,预处理脚本(可选)等。注意:上传的.sh
文件必须为可执行文件。
-
每个中文README.md的小标题:
- 背景介绍:包括历史回顾和问题定义。
- 效果展示:即效果示例图(该小节可选)。
- 模型概览:介绍该教程涉及到的模型,包括对应的公式(不需要推导过程)和模型展示图。
- 数据准备:介绍数据集,以及如何进行预处理。
- 训练模型:在Paddle上是怎样训练模型的。
- 模型配置说明:根据模型概览,对应说明配置内容。
- 训练命令及结果
- 应用模型:在Paddle上是怎样应用模型的。
- 总结
- 参考文献:使用谷歌学术搜索中的GB/T 7714格式。
-
格式要求(md格式):
- 公式:采用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.
- 公式:采用latex格式,分为