如何阅读并学习 MegEngine 的代码

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

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

1. 编译

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

2. 从一个例子入手,自顶向下

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

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

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

  • MegEngine 是如何获取数据集的呢?
  • MegEngine 如何对数据集进行处理?我又要如何实现自己的数据处理方法呢?
  • Functional 中的算子是如何完成计算的呢?GradManager 和 Optimizer 如何管理我的参数梯度呢?
  • 训练和推理出了问题,我又该如何调试呢?

每个开发者 / 用户的关注点都可能不同,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/add-an-operator.html,因为上层要调用下层的实现。对于各模块作用以及调用关系感到困惑的话可以参考 MegEngine 的架构设计文档:https://www.megengine.org.cn/doc/stable/zh/development/architecture-design/index.html。

3. 如何进阶

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

https://www.megengine.org.cn/doc/stable/zh/development/architecture-design/index.html

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

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

4. 寻求帮助

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,816评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,729评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,300评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,780评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,890评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,084评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,151评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,912评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,355评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,666评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,809评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,504评论 4 334
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,150评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,882评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,121评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,628评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,724评论 2 351

推荐阅读更多精彩内容