oneflow-documentation

oneflow-documentation copied to clipboard

先留个坑，之后补齐。 ## OneFlow API 文档基本情况 ## 中英文 API 文档维护常见问题 ## 用什么方案解决上述问题

doombeaker

nn.Graph Tutorial of Pipieline Parallel

1

pipeline，需要完善教程，发现中兴killy，使用pipeline时，只配置了stage但是没有配置grad acc. 或者这个可以做成自动的？ 比如发现 stage id 配置以后，自动设置 grad acc steps from @chengtbf

strint

调研和排查当前 API 文档中需要改善的接口

13

在 API 文档 https://oneflow.readthedocs.io/en/master/ 中，因为历史遗留问题，存在一些低级的问题。 主要有以下几类问题： ### **导出了 API，但是没有文档** 如：https://oneflow.readthedocs.io/en/master/module.html#oneflow.nn.Module.apply  ### 导出了 API，但是函数原型是空的，并且不正确 如：https://oneflow.readthedocs.io/en/master/oneflow.html#oneflow.tensor  这个 `tensor` 方法，显然有多个参数，原型并不是 `tensor()` **解决方法** 这类问题常常是因为，直接从 C 导出的接口，文档编译生成系统无法提取到正确的函数原型。因此其实要在 docstring 中的第一行显式写出。 像这样：https://github.com/Oneflow-Inc/oneflow/blob/master/python/oneflow/framework/docstr/array_ops.py#L369 ### 公式格式问题 如：https://oneflow.readthedocs.io/en/master/functional.html#oneflow.nn.functional.hardsigmoid...

doombeaker

nn.Graph Turotial of Activation Checkpointing

1

接口：https://oneflow.readthedocs.io/en/master/graph.html#oneflow.nn.graph.block_config.BlockConfig.activation_checkpointing 参考的例子： https://github.com/Oneflow-Inc/oneflow/blob/master/python/oneflow/test/graph/test_graph_activation_checkpoint.py 参考背景资料：https://pytorch.org/docs/stable/checkpoint.html

strint

之前用的 livere 留言板，这个商业服务时不时注入广告，挺影响感官的。 我们需要调研并加入免费、开源、无广告的留言板功能。 比如蔡晟航推荐的：https://github.com/utterance/utterances 把它集成到此仓库应该不难。

doombeaker

基础专题里涉及到 flow.uitls 的部分需要更新

3

比如 ```python import oneflow.utils.vision.transforms as transforms ``` 需要改为 `import flowvision.transforms as transforms`。 需要改的地方有： 1. 中文版 2. 英文版 3. 云平台 不过 `flowvision` 也在过渡中，可能有些方法还不全，云平台的镜像默认也还没安装 flowvision。需要等： 1. flowvision 较成熟，有专门的文档 2. 云平台支持 flowvision 再来修改本仓库代码（有些例子就可以直接利用...

doombeaker