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

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

克隆仓库
  • 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