PyTorch Hub
流程
我们通过在 hub
仓库中提交PR来接受PyTorch hub的提交。一旦PR在此处合并到主分支,它将在24小时内显示在 PyTorch网站 上。
提交到PyTorch hub的步骤
- 按照 torch.hub文档 的说明,在你的仓库中添加一个
hubconf.py
文件。通过在本地运行torch.hub.load(...)
来验证它是否正常工作。 - 在
pytorch/hub
仓库中创建一个PR。对于每个新模型,使用此 模板 创建一个<仓库所有者>_<仓库名称>_<标题>.md
文件。
注意事项
- 目前我们不支持托管预训练权重,拥有预训练权重的用户需要自行妥善托管。
- 通常我们建议每个markdown文件对应一个模型,结构相似的模型如
resnet18, resnet50
应放在同一个文件中。 - 如果你有图片,请将它们放在
images/
文件夹中,并在上方的[images/featured_image_1/featured_image_2]
字段中正确链接它们。 - 我们只支持预定义的一组标签,当前它们列在 scripts/tags.py 中。我们接受PR来根据需要扩展这个集合。
- 要在本地测试你的PR,请运行以下测试。
python scripts/sanity_check.py
./scripts/run_pytorch.sh
- 我们的CI会将一个markdown文件中的所有Python代码块连接起来,并针对最新的PyTorch版本运行。
- 记得在你的模型的markdown文件中使用
```python
标记你的Python代码。 - 如果你的
dependencies
未在我们的CI机器上安装,请在 install.sh 中添加它们。 - 如果失败,你可以在仓库中找到一个新的
temp.py
文件来重现失败。
- 记得在你的模型的markdown文件中使用
- 我们还通过
netlify bot
提供了预览你的模型网页的方式。这个机器人使用最新的pytorch.github.io
仓库构建你的PR,并在你的PR上评论预览链接。当你向PR推送更多提交时,预览会更新。