Skip to content

  • 体验新版
    • 正在加载...
  • 登录
  • PaddlePaddle
  • book
  • Wiki
  • 中文教程撰写统一标准

B
book
  • 项目概览

PaddlePaddle / book

通知 17
Star 4
Fork 0
  • 代码
    • 文件
    • 提交
    • 分支
    • Tags
    • 贡献者
    • 分支图
    • Diff
  • Issue 40
    • 列表
    • 看板
    • 标记
    • 里程碑
  • 合并请求 37
  • Wiki 5
    • Wiki
  • 分析
    • 仓库
    • DevOps
  • 项目成员
  • Pages
B
book
  • 项目概览
    • 项目概览
    • 详情
    • 发布
  • 仓库
    • 仓库
    • 文件
    • 提交
    • 分支
    • 标签
    • 贡献者
    • 分支图
    • 比较
  • Issue 40
    • Issue 40
    • 列表
    • 看板
    • 标记
    • 里程碑
  • 合并请求 37
    • 合并请求 37
  • Pages
  • 分析
    • 分析
    • 仓库分析
    • DevOps
  • Wiki 5
    • Wiki
  • 成员
    • 成员
  • 收起侧边栏
  • 动态
  • 分支图
  • 创建新Issue
  • 提交
  • Issue看板

中文教程撰写统一标准

最后修改来自于Tao Luo 12月 27, 2016
页面历史
  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格式):

    • 公式:采用latex格式,分为$ 行内公式 $、$$ 行间公式 $$等。具体请参阅markdown公式指导手册,英文版。
    • 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.
  4. 已有参考:Github Markdown常见问题,如何贡献代码,文档目录,代码目录。

克隆仓库
  • Github Markdown常见问题
  • Home
  • PaddlePaddle Document for HackMIT
  • 【Unofficial】Using Pre trained Models
  • 中文教程撰写统一标准
渝ICP备2023009037号

京公网安备11010502055752号

网络110报警服务 Powered by GitLab CE v13.7
开源知识
Git 入门 Pro Git 电子书 在线学 Git
Markdown 基础入门 IT 技术知识开源图谱
帮助
使用手册 反馈建议 博客
《GitCode 隐私声明》 《GitCode 服务条款》 关于GitCode
Powered by GitLab CE v13.7