Skip to content

模型验收&pr提交标准 #38

@Ldpe2G

Description

@Ldpe2G

复现好的模型,代码提交 Oneflow-Inc/models 仓库统一管理。

对于能找到Pytorch官方实现的模型,比如视觉分类网络,直接对齐torch实现然后把torch的预训练模型直接转成oneflow来用,复现的模型代码需要提供:

  • 训练脚本
  • 预训练模型
  • 预测脚本
  • requirements.txt
  • README

获取运行当前目录下 python 脚本所需的 requirements.txt

pip3 install pipreqs --user
pipreqs . --no-pin

README.md 要用英文来写,具体内容和格式可以参考:resnet50。如果是生成类或者像素级任务,比如 GAN,风格化、分割和超分等等,则需要在 README.md 中提供可视化的结果。

代码中的注释也要用英文来写。

预训练模型需要上传到阿里云,可以暂时先发给我统一上传。模型保存方式,可以参考:
https://github.com/Oneflow-Inc/models/blob/main/resnet50/train_oneflow.py#L120

预测或者训练python脚本需同时提供 bash 脚本,用于方便用户设置一些可变的命令行参数。比如预测脚本,可在bash脚本中下载预训练模型,尽量要让用户下载代码装好oneflow之后,直接运行 bash 脚本就能跑起来。比如 resnet50/infer.sh

提交pr之后,reviewer 要添加 oneflow-ci-bot 对代码进行格式化。

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions