在OneFlow做技术文档工程师是怎样的体验？

Posted 2021-12-20 OneFlow深度学习框架

不少因为热爱技术而关注 OneFlow 的同学，想参与 OneFlow 的实习又怕 OneFlow 的分布式深度学习框架、大模型训练等硬核技术的学习曲线太陡峭，有点纠结要准备到什么程度再到 OneFlow 来实习。

其实，有技术抱负又还在纠结的同学，不妨先考虑下 OneFlow 的技术文档工程师实习岗。

1

OneFlow 的文档实习日常做什么

不少同学来 OneFlow 实习之前，会以为技术文档的工作是做用户手册。

这没说错，但是片面了。

OneFlow 目前维护的用户手册主要包括 API 手册（中文 / 英文）以及教程（中文 / 英文）。

文档地址：

https://oneflow.readthedocs.io/en/master/

https://docs.oneflow.org/master/index.html

OneFlow API 手册最初的版本，是实习生 zzk 几乎以一己之力肝完的，zzk 一边受到狂写 sphinx 语法恐惧的支配，一边借这个机会全面巩固了自己对算子掌握的能力（毕竟看别人的文档，和写文档给别人看，还要确保正确，知识留存率大不一样），还顺便发现了几个算子的 BUG，并一边找同事请教一边学 C++ 自己修复了那些 BUG。目前，zzk 已不在 OneFlow 实习，而是成为了 OneFlow 框架研发工程师，并且能同时驾驭“算法”和“框架研发”两个赛道。

现在的技术文档的同事不再像 zzk 那样受到 “饱和式攻击了”，实际上绝大多数新增的 API 文档，会在 API 新增时就由开发人员添加好，技术文档的同事主要负责 API 文档的查漏补缺和翻译。

除了用户手册这类“常规操作”外，OneFlow 的技术文档工作，也有很“硬核”的工作，需要有技术抱负的同学参与。

OneFlow 中的技术创新和最佳工程实践，这些技术闪光点应该被更多人知晓，也值得被更多人知晓。

OneFlow 已经做过一些展示，比如介绍 OneFlow 分布式优势和性能优化原理的博文：

• OneFlow -- 让每一位算法工程师都有能力训练 GPT

• 如何实现一个高效的 Softmax CUDA kernel？

• OneFlow 中的错误处理

• Credit-based Flow Control 的前世今生

也包括用户手册中关于分布式训练的一手资料：常见的分布式并行策略、集群的一致性视角等（https://docs.oneflow.org/master/parallelism/01_introduction.html）。

这些原创技术资料，有些直接由 OneFlow 的研发工程师产出，有些由技术文档工程师与研发工程师沟通后整理产出，无论作者是谁，他们最终一定是真正搞懂了自己所写内容的原理。参与这些文档制作的过程，也是吸收技术，自我成长的过程。

而且这样的“产出+学习+成长”的场景，除了技术博文外，还有专利的技术说明书、OneFlow 论文投稿等场景，实习生也是可以参与的。

除此之外，OneFlow 还在内容输出领域寻找“做大事”的机会，比如，谈到编译原理大家首先想到的书籍很可能是“龙书”；谈到算法分析会想到 TAOCP；谈到系统会想到 CSAPP；谈到深度学习会想到花书、d2l。

现在加入，是有机会在分布式深度学习框架的内容输出领域，烙上 OneFlow 时代印记的（秘密在筹）。

2

OneFlow 技术文档实习的具体要求

对于有技术抱负的技术文档实习生，望你知晓在内容输出领域有“1+1>2”的规律，即技能越综合在一个人身上，最终的产出效果可能越好。因此希望你既有“读懂 OneFlow 技术原理”的目标和信心，又有写作的习惯、爱好。

对实习生而言，目标与志气可能比当下掌握的具体技能、工具更重要。OneFlow 的环境也可以帮助有抱负的实习生更快成长为自己期待的样子。

以下是基本要求（现在不会也没关系，在面试前掌握就可以了）：

• 熟悉 Markdown 基本语法

• 熟悉基本的 Git 操作

• 使用过 Python 语言

• 工科背景

以下所列均为加分项，不算硬性要求：

• 有 TensorFlow、PyTorch、OneFlow 等深度学习框架中的起码某一种的实操经验

• 掌握 C++，能在指导下读懂 OneFlow 源码，提炼技术原理

• 受过合格的学术训练，有自主查阅文献、阅读论文的能力

• 在过去较长的一段时间内，有写学习笔记、技术笔记(博客、公众号等)的习惯

简历投递地址：[e-mail]

欢迎下载体验OneFlow新一代开源深度学习框架：https://github.com/Oneflow-Inc/oneflow