Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Call for Contribution] Tutorials for PaddlePaddle 2.1(基于飞桨2.1的应用案例教程建设) #799

Open
tngt opened this issue Dec 1, 2021 · 0 comments

Comments

@tngt
Copy link
Member

tngt commented Dec 1, 2021

1. 目标

目前飞桨框架2.1版本已经发布,不久的将来即将发布2.2正式版,在2.1版本中,飞桨框架面向用户体验做了一系列的升级优化
。为了能够让用户快速掌握到飞桨框架升级内容,并了解和学习如何使用2.1进行相关任务的开发,我们进行应用案例教程的立项,在不同的任务场景上为用户提供一个端到端的易学案例,来快速的传递相关知识和使用方法。

在此呼吁广大的飞桨开发者来一起共建我们的应用案例教程,努力为用户提供更加优质的示例教程,为用户学会使用框架铺设一条高速公路。

2. 教程清单

目前我们从已有内容和待补充方向进行了初步评估,梳理了以下建议的选题方向和题目,并为大家提供了比较优秀的对标文章进行学习参考,大家可以从这个列表中选择自己想要进行贡献的题目,或者也可以进行非列表内的题目自选。

招募列表(8.23日公开)

序号 领域 题目 参考 认领人
01 机器学习 负荷预测 0.1 负荷预测0.1 - 飞桨AI Studio linsl1986
02 NLP 基于TextCNN的THUCNews文本分类任务
03 NLP 基于seq2seq的WMT-16机器翻
04 NLP 基于预训练模型完成实体关系抽取 『NLP打卡营』实践课4 基于预训练模型完成实体关系抽取 - 飞桨AI Studio
05 NLP CCKS 2021篇章级事件元素抽取 CCKS 2021篇章级事件元素抽取 - 飞桨AI Studio - 人工智能学习实训社区
06 语音 动手搭建轻量级机器同传翻译系统 『NLP打卡营』实践课8:动手搭建轻量级机器同传翻译系统 - 飞桨AI Studio
07 CV 深入了解DeepLabv3图像分割算法 lutianhao
08 CV 基于SlowFast的视频分类 KHB1698
09 推荐 局部敏感哈希原理解读
10 推荐 DeepFM的原理解读 sleepingxin
11 推荐 GNN的原理解读
12 推荐 Wide&Deep的原理解读
13 推荐 youtubeDNN原理解读
14 强化学习 SAC算法实现月球着陆器着陆 基于飞桨复现强化学习进阶算法SAC,让月球着陆器顺利着陆 - 飞桨AI Studio
15 强化学习 PPO算法实现四轴飞行器 PARL框架下入门PPO:一个战胜世界冠军的强化学习算法
16 强化学习 AlphaZero下五子棋
17 强化学习 MuZero实现CartPole 极简MuZero算法实践——Paddle2.0版本 - 飞桨AI Studio
18 NLP 情话生成送给你 发愁七夕文案?PaddleHub情话生成送给你 (文内含七夕抽奖) - 飞桨AI Studio
19 NLP 使用预训练模型实现快递单信息抽取 『NLP打卡营』实践课3:使用预训练模型实现快递单信息抽取 - 飞桨AI Studio
20 NLP 恶意网页识别 使用PaddleNLP进行恶意网页识别(七):网页二维码解析识别思路与实现 - 飞桨AI Studio
21 OCR 车牌识别 PaddleOCR:车牌识别 - 飞桨AI Studio
22 GAN 天下第一AI武道会-Deepfake换脸 天下第一AI武道会-Deepfake换脸 - 飞桨AI Studio
23 GAN 老北京城影像修复 老北京城影像修复 - 飞桨AI Studio KHB1698
24 GAN 精准唇形合成 【飞桨创意之星】宋代诗人念诗的秘密--PaddleGAN实现精准唇形合成 - 飞桨AI Studio
25 Video 给视频打标签 Skye2099
26 Video 基于PaddleVideo定位精彩足球动作
27 CV 基于PP-YOLOv2实现标注物检测
28 推荐 基于深度学习的音乐推荐 july-ML6-final-project/wsdm_music_recommendation: Final project for July Recommendation course
29 强化学习 DQN算法玩合成大西瓜 PARL强化学习——合成大西瓜 - 飞桨AI Studio tangjitingji
30 CV 来自肺部 CT 扫描的 3D 图像分类 3D image classification from CT scans KHB1698

招募列表外开发者主动贡献列表

3. 贡献指南

3.1 飞桨框架2.1版本安装和使用

  1. 飞桨(PaddlePaddle)版本统一使用2.1最新版,安装说明:https://www.paddlepaddle.org.cn/install/quick
  2. 2.1版本使用教程:https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html
  3. 2.1版本已有应用实践教程:https://www.paddlepaddle.org.cn/documentation/docs/zh/tutorial/index_cn.html

3.2 题目认领

  1. 可以在上面提供的列表中进行题目选择或自选题目,并将确定的题目回复到本Issue中,方便他人同步知晓已开展的文章列表信息,避免重复选题。

3.3 教程编写

  1. 应用案例教程统一使用Notebook格式(.ipynb)来进行编写,可以在本地安装使用Jupyter开发,或使用AIStudio(https://aistudio.baidu.com)。

  2. 为了方便大家进行教程的编写,并统一阅读体验,下面为大家提供了一个简单的概要框架,大家根据实际任务按照下面的框架结构进行内容编写和组织,可以结合实际场景进行微调。如果对模板有一些建议我们也可以在下面进行回复讨论。

    # 题目
    
    作者信息:Github ID (github个人主页URL)
    
    ## 1. 简要介绍
    简单的一段文字介绍本案例场景和用到的一些知识点,不用太复杂的讲述知识细节,
    
    ## 2. 环境设置
    导入包,运行一些初始化方法
    
    ## 3. 数据集
    讲述数据集的一些基础信息,描述数据集组成等。进行数据集的下载、抽样查看、数据集定义等。
    
    ## 4. 模型组网
    基于Layer定义模型网络结构,模型的可视化展示。可以概要讲述一些网络结构代码设计的原因。
    
    ## 5. 模型训练
    使用模型网络结构和数据集进行模型训练。需要讲述一些实践中的知识点。
    
    ## 6. 模型评估
    使用评估数据评估训练好的模型。
    
    ## 7. 模型预测
    对模型进行预测,展示效果。

3.4 教程上传

  1. 写好的文档通过向[https://github.com/PaddlePaddle/docs)仓库提交Pull Request的方式来进行教程文档的上传。
  2. 对提交好的PR可以指定Reviewer TCChenlong)、tngt进行内容和代码的评审,通过后会由具有Merge权限的同学进行最终的合入。

3.5 一些原则

  • 代码封装得当,易读性好,不用一些随意的变量/类/函数命名。
  • 注释清晰,不仅说明做了什么,也要说明为什么这么做。
  • 文字部分暂时不用考虑国际化,先统一使用中文编写,注意概念和描述的清晰度,尽量让大家通俗易懂,如果实在难以解释,可以给出一些能够详细介绍的页面链接。
  • 代码编写过程中能使用高层API的部分就使用高层API,无法使用高层API的部分就使用基础API。高层API使用指南:链接
  • 做好代码的自测工作,每段代码块需要有运行结果。

4. 已合入仓库的教程

目前已经有13篇基于飞桨2.0的教程贡献,查看方式:

  1. Repo目录查看已经Merge的Notebook源文件:docs/practices
  2. 查看官网渲染后的页面:应用实践

5. 还有不清楚的怎么办?

欢迎大家随时在这个Issue下进行提问。

非常感谢大家一起来贡献!共建飞桨繁荣社区!

@tngt tngt pinned this issue Dec 1, 2021
@jzhang533 jzhang533 unpinned this issue Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant