PyTorch Hub

物流信息

我们通过 hub 仓库中的 PR 接受向 PyTorch Hub 的提交。一旦 PR 在这里合并到 master 分支，它将在 24 小时内显示在 PyTorch 官网 上。

向 PyTorch Hub 提交的步骤

1. 在您的仓库中添加一个 hubconf.py 文件，按照 torch.hub 文档 中的说明进行操作。通过在本地运行 torch.hub.load(...) 来验证其是否正常工作。
2. 在 pytorch/hub 仓库中创建一个 PR。对于您拥有的每个新模型，请使用此 模板 创建一个 <repo_owner>_<repo_name>_<title>.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 的新文件，用于重现失败原因。
• 我们还提供一种通过 netlify bot 预览您的模型网页的方式。该机器人会使用最新的 pytorch.github.io 仓库构建您的 PR，并在 PR 中留下一个预览链接。每当您向 PR 推送更多提交时，预览内容都会更新。

PyTorch Hub 快速上手指南

PyTorch Hub 是一个预训练模型库，旨在简化深度学习模型的发现、加载和复用过程。本指南将帮助你快速提交和使用模型。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows
• Python：建议 Python 3.6 及以上版本
• 核心依赖：已安装最新版本的 PyTorch

  pip install torch torchvision
  

• 版本控制：已安装 Git
• 网络环境：能够访问 GitHub 和 PyTorch 官方资源（国内用户若遇下载缓慢，可配置相关代理或使用国内镜像源加速 pip 包安装）

安装与提交流程

PyTorch Hub 本身不是一个需要“安装”的独立软件包，而是一个通过 Pull Request (PR) 向 pytorch/hub 仓库贡献模型的流程。一旦合并，模型将在 24 小时内出现在 PyTorch 官网。

1. 准备模型仓库

在你的模型代码仓库根目录下添加一个 hubconf.py 文件。

• 遵循 torch.hub 文档 中的规范编写该文件。
• 本地验证：在本地运行以下命令确保模型可正确加载（替换为你的仓库信息）：

  import torch
  model = torch.hub.load('your_github_username/your_repo_name', 'model_entry_point', pretrained=True)
  

注意：目前 PyTorch Hub 不提供预训练权重托管服务，你需要自行托管权重文件（如 AWS S3, Google Drive 等），并在代码中提供下载链接。

2. 创建 Pull Request

前往 pytorch/hub 仓库创建 PR：

1. 新建文档：为每个新模型创建一个 Markdown 文件，命名格式为 <repo_owner>_<repo_name>_<title>.md。
   • 请使用官方提供的 模板。
   • 结构相似的模型（如 resnet18, resnet50）应放在同一个文件中。
2. 处理图片：如有示意图，请将图片放入 images/ 文件夹，并在 Markdown 文件的 featured_image 字段中正确链接。
3. 标签设置：仅使用预定义的标签列表（见 scripts/tags.py）。如需新增标签，可单独提交 PR。

3. 本地测试与预览

在提交 PR 前，建议在本地运行测试以确保合规：

# 运行完整性检查
python scripts/sanity_check.py

# 运行 PyTorch 脚本测试
./scripts/run_pytorch.sh

关键检查点：

• Markdown 文件中的 Python 代码块必须标记为 ```python。
• 如果模型依赖额外的库，请在 scripts/install.sh 中添加安装命令，以便 CI 环境能正确构建。
• CI 会将所有代码块合并为 temp.py 并针对最新 PyTorch 版本运行，失败时可查看该文件复现问题。

预览功能： 提交 PR 后，netlify bot 会自动构建预览页面并在评论区提供链接。随着你推送新的 commit，预览链接会自动更新。

基本使用

一旦你的模型被合并到主分支，全球开发者即可通过一行代码加载你的模型。以下是用户使用你模型的标准方式：

import torch

# 语法：torch.hub.load(仓库所有者/仓库名，入口函数名，pretrained=是否加载预训练权重)
model = torch.hub.load('your_github_username/your_repo_name', 'model_entry_point', pretrained=True)

# 设置为评估模式
model.eval()

# 准备输入数据 (示例)
# input_data = ... 
# output = model(input_data)

对于普通开发者，若想使用库中已有的模型（例如 ResNet-18），只需执行：

import torch

# 直接从 PyTorch Hub 加载官方托管的模型
model = torch.hub.load('pytorch/vision:v0.10.0', 'resnet18', pretrained=True)
model.eval()