如何阅读并学习 MegEngine 的代码

旷视开源的深度学习框架 MegEngine，MegEngine 是一个快速、可拓展、易于使用且支持自动求导的深度学习框架。

以最新的 release 版本 release-1.13.0 为例介绍一下 MegEngine 的代码结构以及如何学习 MegEngine 的代码。

1. 编译

对于学习大型项目，我们建议源码编译项目而不是直接安装包，这样我们可以直接修改代码（并编译）再观察我们的改动的影响。

大型项目动辄几千上万条 commit，代码行数也是几十万行起步，把每个 commit、每一行代码都看一遍对于个人开发者来说显然是不现实的。因此我们应该先从较为重要的、我们比较关心的文件入手，慢慢拓展我们对于项目的认知。

在 MegEngine 的官方文档中提供了一个用 MegEngine 实现手写数字识别的例子。

看了这个例子后，你可能会有以下疑问：

每个开发者 / 用户的关注点都可能不同，Python 层作为深度学习框架的入口，我们可以从这里的代码学习起来：https://github.com/MegEngine/MegEngine/tree/master/imperative/python/megengine

粗略浏览一下目录结构，可以看到这里实现了很多 Python 层的接口，可以挑一个感兴趣的开始看，我们推荐从 functional 开始，这里实现了常用的算子，你也可以在这里添加算子。

比如我们的例子中用了 conv 算子，我们就可以跳转到这个算子的实现：https://github.com/MegEngine/MegEngine/blob/master/imperative/python/megengine/functional/nn.py#L224，通过阅读函数的注释我们可以知道每个参数都是做什么的，逐行读下来之后我们会发现这里做的最主要的一件事就是把参数扔到一个 builtin.Convolution 的东西之后去执行（apply）了。这里做的事是：python 层的算子实现需要调用 C++ 的算子实现，builtin.xxx 作为一个接口可以理解为让我们在 Python 程序中接入我们的 C++ 算子实现。这里可以参考 MegEngine 官方文档中关于添加算子的描述，找到我们关心的算子的实现，比如 conv：https://github.com/MegEngine/MegEngine/blob/master/imperative/src/impl/ops/convolution.cpp#L15。

直接看算子的 C++ 实现可能会一头雾水，这时候建议照着 MegEngine 的官方文档，自底向上看（MegDNN→Graph Runtime→Imperative Runtime）：https://www.megengine.org.cn/doc/stable/zh/development/how-to...，因为上层要调用下层的实现。对于各模块作用以及调用关系感到困惑的话可以参考 MegEngine 的架构设计文档：https://www.megengine.org.cn/doc/stable/zh/development/architecture-design/index.html。

了解了一个算子的 Python 实现向下到具体的硬件实现之后，~~你可能会有更多的疑问~~，你可能会对 MegEngine 如何提供基础设施支持上层的算法开发感到好奇，我们再看一眼 MegEngine 的架构设计图：

不得不说单看图就可知这里涉及到的组件数量众多、调用关系复杂。个人是难以在短时间内掌握所有组件的架构细节的（更不可能把代码全看一遍了）。我们推荐根据架构图先简单了解各个模块的功能：每个模块的作用、与上下游其他模块之间的关系。在对于项目整体架构有了粗略把握之后，再对我们感兴趣的模块进行更深入的研究。

MegEngine 中动态图（imperative runtime）部分的内容主要在：https://github.com/MegEngine/MegEngine/tree/master/imperative
MegEngine 中静态图（graph runtime）部分的内容主要在：https://github.com/MegEngine/MegEngine/tree/master/src
MegEngine 中硬件算子库（MegDNN）部分的内容主要在：https://github.com/MegEngine/MegEngine/tree/master/dnn

感兴趣的同学可以深入源码进行研究，可以边看代码边改、解决项目现有的 issues、为仓库贡献代码等都是很好的学习方式。

一个人学习大型项目难免会有非常多的疑问，在学习的过程中应当多查阅资料、多于他人交流。遇到困难时可以获得帮助的手段有：

欢迎参与 MegEngine 社区贡献，成为 Awesome MegEngineer，荣誉证书、定制礼品享不停。