|
|
|
1. 每个中文教程含有以下子目录：
|
|
|
|
- 背景介绍：即问题定义。
|
|
|
|
1. 每个教程文件夹的目录结构如下：
|
|
|
|
- data：存放下载的数据、模型，以及下载脚本。预处理后的数据（可选）也放在该文件夹。
|
|
|
|
- image：存放图片。图片需大小适中，img/png格式，且命名不能采用1.img等无法说明该图内容的方式。
|
|
|
|
- README.md：中文教程。
|
|
|
|
- src：存放模型配置`.py`，训练和预测脚本`.sh`，预处理脚本（可选）等。注意：上传的`.sh`文件必须为可执行文件。
|
|
|
|
|
|
|
|
1. 每个中文README.md的小标题：
|
|
|
|
- 背景介绍：包括历史回顾和问题定义。
|
|
|
|
- 效果展示：即效果示例图（该小节可选）。
|
|
|
|
- 模型概览：介绍该教程涉及到的模型，包括对应的公式（不需要推导过程）和模型展示图。
|
|
|
|
- 数据准备：介绍数据集，以及如何进行预处理。
|
|
|
|
- 训练模型：在Paddle上是怎样训练模型的。
|
|
|
|
- 模型配置说明：根据模型概览，对应说明配置内容。
|
|
|
|
- 训练命令及结果
|
|
|
|
- 应用模型：在Paddle上是怎样应用模型的。
|
|
|
|
- 总结
|
|
|
|
- 参考文献：使用[谷歌学术搜索](https://scholar.google.com/schhp?hl=zh-CN)中的GB/T 7714格式。
|
|
|
|
|
|
|
|
2. 格式要求（md格式）：
|
|
|
|
- 图片：大小适中，img/png格式，统一放置在当前目录的image文件夹下。命名不能采用1.img等无法说明该图内容的方式。
|
|
|
|
1. 格式要求（md格式）：
|
|
|
|
- 公式：采用latex格式，分为`$ 行内公式 $`、`$$ 行间公式 $$`等。具体请参阅[markdown公式指导手册](http://www.tuicool.com/articles/mEzqeaM)。让github支持公式显示的chrome插件[GitHub with MathJax](https://chrome.google.com/webstore/detail/github-with-mathjax/ioemnmodlmafdkllaclgeombjnmnbima)
|
|
|
|
- `function`格式：文件名如`dataprovider.py`和代码中的函数名如`forward`采用该格式；层名如fc不采用该格式。
|
|
|
|
- 参考文献：GB/T 7714格式请参阅[具体步骤](http://www.lxws.net/new.php?id=381)，同时在标题中加入文章链接。示例如：Bahdanau D, Cho K, Bengio Y. [Neural machine translation by jointly learning to align and translate](https://arxiv.org/abs/1409.0473)[J]. arXiv preprint arXiv:1409.0473, 2014.
|
|
|
|
|
|
|
|
3. 已有参考：[文档目录](https://github.com/PaddlePaddle/Paddle/tree/develop/doc/tutorials)，[代码目录](https://github.com/PaddlePaddle/Paddle/tree/develop/demo)。 |
|
|
\ No newline at end of file |
|
|
|
1. 已有参考：[文档目录](https://github.com/PaddlePaddle/Paddle/tree/develop/doc/tutorials)，[代码目录](https://github.com/PaddlePaddle/Paddle/tree/develop/demo)。 |
|
|
\ No newline at end of file |
