技巧总结

开发必看

• 使用 VS Code 开发和调试 OneFlow ，可搭配 VSCode debug 工具 一起食用
• howto_write_api_doc ，强调：make html 前 pip requirements
• Functional Interface
• 深度学习框架如何优雅的做算子对齐任务
• 如何在OneFlow中新增User Op
• 常见的分布式并行策略 系列
• 错误处理：Maybe
• OneFlow 环境变量
• OneFlow inplace 算子开发指南

工具文档

• OneFlow Document Index

技巧

• 查看文档，如查看 nn.functional.conv2d 的文档，可以通过 nn.functional.conv2d.__doc__
• 测试样例不宜过大，因为ci会多进程跑测试，每个样例的内存不能太大，不然可能就oom了
• yaml 中 list 的初始化需要根据 维度 而定，如 Int32List[3] dilation=1 对于 3d， Int32List[2] dilation=1 对于 2d
• 如果在文档字符串中使用任何反斜杠转义，那么需要用r"""your raw docstring"""
• doc 规定文档字符串的代码要有个变量接收结果 outputs = F.conv1d(inputs, filters) 或者直接 F.conv1d(inputs, filters) 并附带上运行结果。可以运行 ./python/oneflow/test/modules/test_functional_docstr.py 来检查文档是否有问题
• 通过 import oneflow as flow; flow; 查看包位置