torch.hub¶

Pytorch Hub 是一个预训练模型仓库，旨在促进研究的可重复性。

发布模型¶

Pytorch Hub 支持通过添加一个简单的 hubconf.py 文件，将预训练模型（模型定义和预训练权重）发布到 GitHub 仓库；

hubconf.py 可以有多个入口点。每个入口点都定义为一个 python 函数（例如：您想要发布的预训练模型）。

def entrypoint_name(*args, **kwargs):
    # args & kwargs are optional, for models which take positional/keyword arguments.
    ...

如何实现入口点？¶

以下代码片段指定了 resnet18 模型的入口点，如果我们扩展 pytorch/vision/hubconf.py 中的实现。在大多数情况下，在 hubconf.py 中导入正确的函数就足够了。这里我们只是想使用扩展版本作为示例来展示其工作原理。您可以在 pytorch/vision repo 中查看完整脚本

dependencies = ['torch']
from torchvision.models.resnet import resnet18 as _resnet18

# resnet18 is the name of entrypoint
def resnet18(pretrained=False, **kwargs):
    """ # This docstring shows up in hub.help()
    Resnet18 model
    pretrained (bool): kwargs, load pretrained weights into the model
    """
    # Call the model, load pretrained weights
    model = _resnet18(pretrained=pretrained, **kwargs)
    return model

dependencies 变量是列表，其中包含加载模型所需的包名称。请注意，这可能与训练模型所需的依赖项略有不同。
args 和 kwargs 会传递给真正的可调用函数。
函数的文档字符串充当帮助消息。它解释了模型的作用以及允许的位置/关键字参数。强烈建议在此处添加一些示例。
入口点函数可以返回模型 (nn.module)，或辅助工具以使用户工作流程更顺畅，例如分词器。
以下划线为前缀的可调用对象被视为辅助函数，不会显示在 torch.hub.list() 中。
预训练权重可以本地存储在 GitHub 仓库中，也可以通过 torch.hub.load_state_dict_from_url() 加载。如果小于 2GB，建议将其附加到项目发布并使用发布中的 url。在上面的示例中，torchvision.models.resnet.resnet18 处理 pretrained，或者您可以将以下逻辑放入入口点定义中。

if pretrained:
    # For checkpoint saved in local GitHub repo, e.g. <RELATIVE_PATH_TO_CHECKPOINT>=weights/save.pth
    dirname = os.path.dirname(__file__)
    checkpoint = os.path.join(dirname, <RELATIVE_PATH_TO_CHECKPOINT>)
    state_dict = torch.load(checkpoint)
    model.load_state_dict(state_dict)

    # For checkpoint saved elsewhere
    checkpoint = 'https://download.pytorch.org/models/resnet18-5c106cde.pth'
    model.load_state_dict(torch.hub.load_state_dict_from_url(checkpoint, progress=False))

重要提示¶

发布的模型应至少位于分支/标签中。它不能是随机提交。

从 Hub 加载模型¶

Pytorch Hub 提供了便捷的 API，可通过 torch.hub.list() 浏览 hub 中的所有可用模型，通过 torch.hub.help() 显示文档字符串和示例，并使用 torch.hub.load() 加载预训练模型。

torch.hub.list(github, force_reload=False, skip_validation=False, trust_repo=None, verbose=True)[source][source]¶

列出 github 指定的仓库中所有可调用的入口点。

参数

github (str) – 格式为 “repo_owner/repo_name[:ref]” 的字符串，带有可选的 ref（标签或分支）。如果未指定 ref，则默认分支假定为 main（如果存在），否则为 master。示例：‘pytorch/vision:0.10’
force_reload (bool, optional) – 是否放弃现有缓存并强制重新下载。默认为 False。
skip_validation (bool, optional) – 如果为 False，torchhub 将检查 github 参数指定的分支或提交是否正确属于仓库所有者。这将向 GitHub API 发出请求；您可以通过设置 GITHUB_TOKEN 环境变量来指定非默认的 GitHub 令牌。默认为 False。
trust_repo (bool, str 或 None) –
"check", True, False 或 None。此参数在 v1.12 中引入，有助于确保用户仅运行来自他们信任的仓库的代码。
- 如果为 False，则会提示用户是否应信任该仓库。
- 如果为 True，则该仓库将添加到受信任列表，并在无需显式确认的情况下加载。
- 如果为 "check"，则将根据缓存中的受信任仓库列表检查该仓库。如果该仓库不在列表中，则行为将回退到 trust_repo=False 选项。
- 如果为 None：这将引发警告，邀请用户将 trust_repo 设置为 False、True 或 "check"。这仅为向后兼容性而存在，将在 v2.0 中删除。
默认为 None，最终将在 v2.0 中更改为 "check"。
verbose (bool, optional) – 如果为 False，则静音有关命中本地缓存的消息。请注意，有关首次下载的消息无法静音。默认为 True。

返回

可用的可调用入口点

返回类型

list

示例

>>> entrypoints = torch.hub.list("pytorch/vision", force_reload=True)

torch.hub.help(github, model, force_reload=False, skip_validation=False, trust_repo=None)[source][source]¶

显示入口点 model 的文档字符串。

参数

github (str) – 格式为 <repo_owner/repo_name[:ref]> 的字符串，带有可选的 ref（标签或分支）。如果未指定 ref，则默认分支假定为 main（如果存在），否则为 master。示例：‘pytorch/vision:0.10’
model (str) – 仓库 hubconf.py 中定义的入口点名称字符串
force_reload (bool, optional) – 是否放弃现有缓存并强制重新下载。默认为 False。
skip_validation (bool, optional) – 如果为 False，torchhub 将检查 github 参数指定的 ref 是否正确属于仓库所有者。这将向 GitHub API 发出请求；您可以通过设置 GITHUB_TOKEN 环境变量来指定非默认的 GitHub 令牌。默认为 False。
trust_repo (bool, str 或 None) –
"check", True, False 或 None。此参数在 v1.12 中引入，有助于确保用户仅运行来自他们信任的仓库的代码。
- 如果为 False，则会提示用户是否应信任该仓库。
- 如果为 True，则该仓库将添加到受信任列表，并在无需显式确认的情况下加载。
- 如果为 "check"，则将根据缓存中的受信任仓库列表检查该仓库。如果该仓库不在列表中，则行为将回退到 trust_repo=False 选项。
- 如果为 None：这将引发警告，邀请用户将 trust_repo 设置为 False、True 或 "check"。这仅为向后兼容性而存在，将在 v2.0 中删除。
默认为 None，最终将在 v2.0 中更改为 "check"。

示例

>>> print(torch.hub.help("pytorch/vision", "resnet18", force_reload=True))

torch.hub.load(repo_or_dir, model, *args, source='github', trust_repo=None, force_reload=False, verbose=True, skip_validation=False, **kwargs)[source][source]¶

从 github 仓库或本地目录加载模型。

注意：加载模型是典型的用例，但也可用于加载其他对象，如分词器、损失函数等。

如果 source 为 ‘github’，则 repo_or_dir 应采用 repo_owner/repo_name[:ref] 形式，带有可选的 ref（标签或分支）。

如果 source 为 ‘local’，则 repo_or_dir 应为本地目录的路径。

参数

repo_or_dir (str) – 如果 source 为 ‘github’，则应对应于 github 仓库，格式为 repo_owner/repo_name[:ref]，带有可选的 ref（标签或分支），例如 ‘pytorch/vision:0.10’。如果未指定 ref，则默认分支假定为 main（如果存在），否则为 master。如果 source 为 ‘local’，则应为本地目录的路径。
model (str) – 仓库/目录的 hubconf.py 中定义的可调用对象（入口点）的名称。
*args (optional) – 可调用对象 model 的相应 args。
source (str, optional) – ‘github’ 或 ‘local’。指定如何解释 repo_or_dir。默认为 ‘github’。
trust_repo (bool, str 或 None) –
"check", True, False 或 None。此参数在 v1.12 中引入，有助于确保用户仅运行来自他们信任的仓库的代码。
- 如果为 False，则会提示用户是否应信任该仓库。
- 如果为 True，则该仓库将添加到受信任列表，并在无需显式确认的情况下加载。
- 如果为 "check"，则将根据缓存中的受信任仓库列表检查该仓库。如果该仓库不在列表中，则行为将回退到 trust_repo=False 选项。
- 如果为 None：这将引发警告，邀请用户将 trust_repo 设置为 False、True 或 "check"。这仅为向后兼容性而存在，将在 v2.0 中删除。
默认为 None，最终将在 v2.0 中更改为 "check"。
force_reload (bool, optional) – 是否无条件强制重新下载 github 仓库。如果 source = 'local'，则无效。默认为 False。
verbose (bool, optional) – 如果为 False，则静音有关命中本地缓存的消息。请注意，有关首次下载的消息无法静音。如果 source = 'local'，则无效。默认为 True。
skip_validation (bool, optional) – 如果为 False，torchhub 将检查 github 参数指定的分支或提交是否正确属于仓库所有者。这将向 GitHub API 发出请求；您可以通过设置 GITHUB_TOKEN 环境变量来指定非默认的 GitHub 令牌。默认为 False。
**kwargs (optional) – 可调用对象 model 的相应 kwargs。

返回

使用给定的 *args 和 **kwargs 调用 model 可调用对象的输出。

示例

>>> # from a github repo
>>> repo = "pytorch/vision"
>>> model = torch.hub.load(
...     repo, "resnet50", weights="ResNet50_Weights.IMAGENET1K_V1"
... )
>>> # from a local directory
>>> path = "/some/local/path/pytorch/vision"
>>> model = torch.hub.load(path, "resnet50", weights="ResNet50_Weights.DEFAULT")

torch.hub.download_url_to_file(url, dst, hash_prefix=None, progress=True)[source][source]¶

将给定 URL 的对象下载到本地路径。

参数

url (str) – 要下载的对象的 URL
dst (str) – 将保存对象的完整路径，例如 /tmp/temporary_file
hash_prefix (str, optional) – 如果不为 None，则 SHA256 下载文件的开头应为 hash_prefix。默认值：None
progress (bool, optional) – 是否向 stderr 显示进度条。默认值：True

示例

>>> torch.hub.download_url_to_file(
...     "https://s3.amazonaws.com/pytorch/models/resnet18-5c106cde.pth",
...     "/tmp/temporary_file",
... )

torch.hub.load_state_dict_from_url(url, model_dir=None, map_location=None, progress=True, check_hash=False, file_name=None, weights_only=False)[source][source]¶

加载给定 URL 处的 Torch 序列化对象。

如果下载的文件是 zip 文件，它将自动解压缩。

如果对象已存在于 model_dir 中，则会反序列化并返回。 model_dir 的默认值为 <hub_dir>/checkpoints，其中 hub_dir 是 get_dir() 返回的目录。

参数

url (str) – 要下载的对象的 URL
model_dir (str, optional) – 用于保存对象的目录
map_location (optional) – 指定如何重新映射存储位置的函数或字典（请参阅 torch.load）
progress (bool, optional) – 是否向 stderr 显示进度条。默认值：True
check_hash (bool, optional) – 如果为 True，则 URL 的文件名部分应遵循命名约定 filename-<sha256>.ext，其中 <sha256> 是文件内容 SHA256 哈希的前八位或更多位数字。哈希用于确保名称唯一并验证文件内容。默认值：False
file_name (str, optional) – 下载文件的名称。如果未设置，将使用来自 url 的文件名。
weights_only (bool, optional) – 如果为 True，则仅加载权重，不加载复杂的 pickle 对象。建议用于不受信任的来源。有关更多详细信息，请参阅 load()。

返回类型

Dict[str, Any]

示例

>>> state_dict = torch.hub.load_state_dict_from_url(
...     "https://s3.amazonaws.com/pytorch/models/resnet18-5c106cde.pth"
... )

运行加载的模型：¶

请注意，torch.hub.load() 中的 *args 和 **kwargs 用于实例化模型。加载模型后，如何了解可以使用该模型做什么？建议的工作流程是

dir(model) 查看模型的所有可用方法。
help(model.foo) 检查 model.foo 运行所需的参数

为了帮助用户进行探索而无需来回查阅文档，我们强烈建议仓库所有者使函数帮助消息清晰简洁。包含最简化的工作示例也很有帮助。

我的下载模型保存在哪里？¶

位置按以下顺序使用

调用 hub.set_dir(<PATH_TO_HUB_DIR>)
$TORCH_HOME/hub，如果设置了环境变量 TORCH_HOME。
$XDG_CACHE_HOME/torch/hub，如果设置了环境变量 XDG_CACHE_HOME。
~/.cache/torch/hub

torch.hub.get_dir()[source][source]¶

获取用于存储下载的模型和权重的 Torch Hub 缓存目录。

如果未调用 set_dir()，则默认路径为 $TORCH_HOME/hub，其中环境变量 $TORCH_HOME 默认为 $XDG_CACHE_HOME/torch。$XDG_CACHE_HOME 遵循 Linux 文件系统布局的 X Design Group 规范，如果未设置环境变量，则默认值为 ~/.cache。

返回类型: str

torch.hub.set_dir(d)[source][source]¶

可选地设置用于保存下载的模型和权重的 Torch Hub 目录。

参数: d (str) – 本地文件夹的路径，用于保存下载的模型和权重。

缓存逻辑¶

默认情况下，我们不会在加载文件后清理文件。如果 Hub 缓存已存在于 get_dir() 返回的目录中，则默认使用缓存。

用户可以通过调用 hub.load(..., force_reload=True) 强制重新加载。这将删除现有的 GitHub 文件夹和下载的权重，重新初始化新的下载。当更新发布到同一分支时，这非常有用，用户可以跟上最新版本。

已知限制：¶

Torch Hub 的工作原理是像导入已安装的包一样导入它。在 Python 中导入会引入一些副作用。例如，您可以在 Python 缓存 sys.modules 和 sys.path_importer_cache 中看到新项目，这是正常的 Python 行为。这也意味着，如果不同的仓库具有相同的子包名称（通常是 model 子包），那么从不同的仓库导入不同的模型时，可能会遇到导入错误。解决这些导入错误的一种方法是从 sys.modules 字典中删除有问题的子包；更多详细信息可以在 this GitHub issue 中找到。

这里值得一提的一个已知限制是：用户不能在 同一个 Python 进程 中加载同一个仓库的两个不同分支。这就像在 Python 中安装两个同名的包一样，这是不好的。如果你真的尝试这样做，缓存可能会参与进来并给你带来惊喜。当然，在不同的进程中加载它们是完全没问题的。

torch.hub¶

发布模型¶

如何实现入口点？¶

重要提示¶

从 Hub 加载模型¶

运行加载的模型：¶

我的下载模型保存在哪里？¶

缓存逻辑¶

已知限制：¶

文档

教程

资源