【PaddlePaddle Hackathon 2】70、深度体验飞桨官网文档，并产出一份评估报告 #4689
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your contribution! |
TCChenlong
reviewed
Apr 29, 2022
|
以上信息收到，更新后我会再回复。 |
TCChenlong
reviewed
May 5, 2022
| | 框架设计文档 | Random number generation | 1 | 分散在 API 文档、源码中，其实比较丰富。30+ | 30+ | 设计白皮书 全场景统一 函数式微分编程 动静态图结合 异构并行训练 分布式并行 中间表达 MindIR 高性能数据处理引擎 图算融合加速引擎 二阶优化 可视化调试调优 安全可信 术语 | 13 | | 0 | | ||
| | 其它 | Integrated gradients Uncertainty quantification with SNGP Probabilistic regression Keras一级标题下的13篇文章 Thinking in TensorFlow 2 Data input pipelines 一级标题下的3篇 GPU TPU | 20 | Learn the Basics Quickstart Deep Learning with PyTorch: A 60 Minute Blitz Building a Convolution/Batch Norm fuser in FX Building a Simple CPU Performance Profiler with FX Channels Last Memory Format in PyTorch Forward-mode Automatic Differentiation Using the PyTorch C++ Frontend Dynamic Parallelism in TorchScript Autograd in C++ Frontend Static Quantization with Eager Model in PyTorch | 11 | 基本介绍 快速入门 进阶案例：线性拟合 混合精度 梯度累积算法 自适应梯度求和算法 降维训练算法 | 7 | 10 分钟快速上手飞桨 使用线性回归预测波士顿房价 模型导出 ONNX 协议 飞桨产品硬件支持表 昆仑 XPU 芯片运行飞桨 海光 DCU 芯片运行飞桨 昇腾 NPU 芯片运行飞桨 环境变量 FLAGS 下9篇 hello paddle：从普通程序走向机器学习程序 通过AutoEncoder实现时序数据异常检测 广播介绍 自动混合精度训练 梯度裁剪 升级指南 | 20+ | | ||
|
|
||
| 可以看除，PaddlePaddle 在文档上是比较完备的，但是在个别领域，还比较薄弱甚至空缺，主要是： |
There was a problem hiding this comment.
已经补充，对 paddle 已有覆盖点的部分做了详细说明。对没有的部分，做了横向比较。
|  | ||
|
|
||
|
|
||
| ### 内容分析 |
There was a problem hiding this comment.
这里其实可以对比一下 https://documentation.divio.com/ 这里的理论，补充一些内容的共性问题
There was a problem hiding this comment.
已经在具体的案例分析前，添加了理论的共性问题：Guide 和 Tutorial 区分不清会有什么问题；Guide 和 Refernce 区分不清会有什么问题。而之后的内容，也具体展示了现有文档中的部分这类问题。
|
|
||
|
|
||
|
|
||
| ### 组织结构分析 |
There was a problem hiding this comment.
这里可以针对每一个标题，考虑一下文档的内容是否是完备的~
There was a problem hiding this comment.
上文已经做了完备性分析，所以这里就不再照搬了。不过我添加了一份“文档组织重构建议”，列出了建议的栏目及应该覆盖的文章，以及与现有文档中已有文章的对应关系。
TCChenlong
approved these changes
May 9, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
依据本人提交并已经通过的 RFC PaddlePaddle/community#54 做的飞桨评估报告。
主要包括：