【飞桨体验评测任务第四期】

[sunzhongkai588]

一、背景介绍

2022年飞桨将重点开展开发者生态贡献机制，建立开发者与飞桨的多样化联动，共同打造优秀的开源生态。在今年5月，我们开展了第三次评估，重点放在桨分布式文档的评估与硬件接入文档的评估，共收集到反馈 20+的体验评测报告，为相关产品的优化提供了重要的信息输入。为了进一步提升飞桨框架的使用体验，我们诚挚的邀请你参与到第四期体验评估中，这次主要是飞桨训练框架API文档评估、Paddle Lite 文档评估和Paddle Inference文档评估，并且和我们一起共建飞桨框架，后续会陆续安排其他产品模块的体验评测，希望大家持续关注。

二、参与流程

三、具体任务：

1、飞桨训练框架API 文档评测任务

• 任务名称：API文档体验评测 负责人：陈龙（微信昵称：TC.Long）

• 任务描述：我们精选 30篇常用API文档，分成6组，每组任务包含5篇API文档。你需要先阅读该API文档，然后根据问卷，对该API文档进行评估（注意，每个API都需要单独填写一次问卷，请一定填写正确API名称与你的微信昵称），此外，对于该API的所有建议，都可以填写到主观评价中。

• 任务分配：为了降低bias，每组都会请3位同学来做交叉评测，即你可以在表格的 epoch 1、epoch 2、epoch 3 中任意认领1项任务。

• 任务提交：你需要完成以下操作和内容，
  （1）完成API文档的评估问卷。
  （2）共享 Excel 中更新 API 文档评估状态。
  （3）评测群中 @TC.Long 完成评估

---

2、飞桨Paddle Lite 文档评估任务

一、Paddle Lite文档 - 内容评测任务

• 任务名称：Paddle Lite文档 - 内容评测 负责人群昵称@憨憨

• 任务描述：针对Paddle Lite文档中，关于核心功能使用的几个主要模块，你可根据自己的开发经验及兴趣点，选择一组文档进行针对文档内容的测评（一般具有内容关联性），并为每篇文档需独立填写一次问卷；请选择《文档内容评测问卷》进行填写。

  • 评估范围：单篇文档全部内容（包含链接所指向的外部资源或页面）
  • 评估方式：尽量在阅读文档所有内容并充分理解后，按照问卷评估维度对文档内容打分、并反馈与相关建议和问题；
  • 内容连贯性：如果你发现所阅读内容难以理解，或是文档中明确注明需要依赖前序文档，请首先阅读前序文档内容（大部分文档的任务分组为相对独立的内容模块）

• 任务分配：为了降低bias，每组都会请3位同学来做交叉评测，即你可以在表格的 epoch 1、epoch 2 中任意认领1项任务。

• 任务提交：你需要完成以下操作和内容，

  1. 完成Paddle Lite《内容评测问卷》。
  2. 在共享 Excel 中更新 内容评测 文档评估状态、并填写建议。
  3. 评测群中 @憨憨 完成评估

二、Paddle Lite文档 - 操作实践任务

• 任务名称：Paddle Lite文档 - 操作实践 负责人群昵称@憨憨

• 任务描述：针对Paddle Lite文档中涉及具体操作实践的文档，你需要根据自己的开发经验&软硬件平台情况，选择一组可在本地环境运行的操作实践任务，并为每篇文档需独立填写一次问卷；请选择《操作实践评测问卷》进行填写。

  • 评估范围：文档评估范围为单篇文档内的内容描述，实践体验以及链接所指向的辅助资源中的内容
  • 评估方式：请先熟悉问卷中的评估标准，然后按照文档指引逐步完成文档中的操作步骤，并将进度记录在问卷中的阶段打卡点中；完整完成全部流程、或因某些无法解决的原因导致无法进行后，请将所记录下的与问卷中问题相关的信息，整理并填写到问卷中，完成主观评价指标的选择；
  • 环境限制：对于实践操作类文档，要求开发者拥有与文档内容相匹配的硬件 (相关CPU/GPU/NPU的设备) 和软件 (操作系统) 环境；请在选择前确认有与文档相符的本地环境，如果因客观原因无法满足，可只进行主观评价不用进行操作，并在问卷中注明；
  • 任务选择：建议你在选择任务时，根据自己特定的软硬件环境，匹配关联的文档进行评测（eg. 选取【X86源码编译】完成环境准备，同时选取【X86应用示例】完成应用开发）

• 任务分配：为了降低bias，每组都会请3位同学来做交叉评测，即你可以在表格的 epoch 1、epoch 2 中任意认领1项任务。

• 任务提交：你需要完成以下操作和内容，

  1. 完成Paddle Lite《操作实践评测问卷》
  2. 在共享 Excel 中更新 操作流程 文档评估状态、并填写建议。
  3. 评测群中 @憨憨 完成评估

【在评测过程中，如遇到任何报错或问题，可以在微信群中随时提出，我们会有专门技术同学支持。】

---

3、飞桨Paddle Inference 文档评测任务（负责人微信昵称：雷青）

• 任务参与方式：你需要完成以下操作和步骤：

  1. 请先打开协作链接获取编辑权限，并在 Paddle Inference文档评审任务表 中选择想要认领的任务，写昵称占坑。
  2. 根据任务说明，下载相应评审模版，完成任务后将打分表/报告上传在 Paddle Inference文档评审结果 提交（注意：excel填写“微信昵称+Paddle Inference文档评审”）。
  3. 在 Paddle Inference文档评审任务表中填写表格中的 评审状态（已完成/未完成）和 打分表链接。
  4. 评测群中 @雷青 完成评估。

• 文档获取路径（经过大家评审后的文档，才会上 Paddle 官网）：

  1. 下载docs.zip压缩包
  2. 解压后
  3. 进入docs/html/路径，右键通过浏览器打开README.html即可看到Paddle Inference全景。

• 文档评审任务描述

  序号	任务类型	任务难度	需要评审专家
  1	目录结构-评审	中高阶	>= 3位
  2	文档撰写逻辑内容-评审	中阶	>=12位
  3	全流程打卡-评审	中高阶	>= 8位

  • 任务一：目录结构-评审

    • 任务难度：中高阶
    • 任务内容：评测文档<整体目录>、<子章节目录>、<API目录>等目录。评审专家从开发者使用部署产品的角度，对目前的目录是否符合部署逻辑进行评测打分。具体任务见Paddle Inference文档评审任务表——目录结构 
    • 评测委员：3位使用Paddle Inference的开发者
    • 评分表：《1-Paddle Inference文档体验评估打分表-目录评审》

  • 任务二：文档撰写逻辑、内容等评测

    • 任务难度：中阶
    • 任务内容：阅读Paddle Inferenc各模块具体内容，对文档中的描述逻辑、结构、内容、用词等不同维度进行打分，对文档质量提出建设应建议。具体任务见Paddle Inference文档评审任务表——文档逻辑、内容 
    • 评分表：《2-Paddle Inference文档体验评估打分表-文档逻辑内容评审》

  • 任务三：操作易用性

    • 任务难度：中高等
    • 任务内容：我们提供了4篇不同语言的快速开始文档 和 2篇高性能的CPU、GPU使用文档，评测委员根据该文档， 在自己的电脑上完成该部署操作，并产出一份全流程评估打分表。 具体任务见Paddle Inference文档评审任务表——全流程打卡 
    • 任务评分表：《3-Paddle Inference文档体验评估打分表-全流程打卡评审》

四、答疑

在评估过程中，有任何问题，都可以在群中或此ISSUE下进行提问，我们会尽快解答你的问题~

五、最后

再一次感谢你参与飞桨框架体验评估任务，我们会认真参考你的评分与建议，打造最好用的深度学习框架！
如果您对产品体验评测任务感兴趣，可以直接联系18614069622（微信） 或 扫码加入我们（6月21日前有效）。