torch.package¶

torch.package 添加了对创建包含工件和任意 PyTorch 代码的软件包的支持。这些软件包可以保存、共享、用于在以后或在不同的机器上加载和执行模型，甚至可以使用 torch::deploy 部署到生产环境中。

本文档包含教程、操作指南、说明和 API 参考，可帮助您详细了解 torch.package 及其使用方法。

警告

此模块依赖于 pickle 模块，该模块不安全。仅解包您信任的数据。

可以构建恶意 pickle 数据，这些数据将在 **解包期间执行任意代码**。切勿解包可能来自不受信任的来源或可能被篡改的数据。

有关更多信息，请查看 pickle 模块的文档。

教程 ¶

打包您的第一个模型 ¶

可在 Colab 上找到一个指导您完成简单模型的打包和解包过程的教程。完成此练习后，您将熟悉创建和使用 Torch 软件包的基本 API。

如何……¶

查看软件包内部的内容？¶

将软件包视为 ZIP 存档¶

torch.package 的容器格式为 ZIP，因此任何可用于标准 ZIP 文件的工具都应可用于浏览其内容。一些与 ZIP 文件交互的常用方法

unzip my_package.pt 将解压缩 torch.package 存档到磁盘，您可以在其中自由检查其内容。

$ unzip my_package.pt && tree my_package
my_package
├── .data
│   ├── 94304870911616.storage
│   ├── 94304900784016.storage
│   ├── extern_modules
│   └── version
├── models
│   └── model_1.pkl
└── torchvision
    └── models
        ├── resnet.py
        └── utils.py
~ cd my_package && cat torchvision/models/resnet.py
...

Python zipfile 模块提供了一种标准方法来读取和写入 ZIP 存档内容。

from zipfile import ZipFile
with ZipFile("my_package.pt") as myzip:
    file_bytes = myzip.read("torchvision/models/resnet.py")
    # edit file_bytes in some way
    myzip.writestr("torchvision/models/resnet.py", new_file_bytes)

vim 具有原生读取 ZIP 存档的功能。您甚至可以编辑文件并使用 :write 将它们写回存档！

# add this to your .vimrc to treat `*.pt` files as zip files
au BufReadCmd *.pt call zip#Browse(expand("<amatch>"))

~ vi my_package.pt

使用 `file_structure()` API¶

PackageImporter 提供了一个 file_structure() 方法，该方法将返回一个可打印且可查询的 Directory 对象。Directory 对象是一个简单的目录结构，您可以使用它来浏览 torch.package 的当前内容。

Directory 对象本身是直接可打印的，并将打印出一个文件树表示形式。要过滤返回的内容，请使用 glob 样式的 include 和 exclude 过滤参数。

with PackageExporter('my_package.pt') as pe:
    pe.save_pickle('models', 'model_1.pkl', mod)

importer = PackageImporter('my_package.pt')
# can limit printed items with include/exclude args
print(importer.file_structure(include=["**/utils.py", "**/*.pkl"], exclude="**/*.storage"))
print(importer.file_structure()) # will print out all files

输出

# filtered with glob pattern:
#    include=["**/utils.py", "**/*.pkl"], exclude="**/*.storage"
─── my_package.pt
    ├── models
    │   └── model_1.pkl
    └── torchvision
        └── models
            └── utils.py

# all files
─── my_package.pt
    ├── .data
    │   ├── 94304870911616.storage
    │   ├── 94304900784016.storage
    │   ├── extern_modules
    │   └── version
    ├── models
    │   └── model_1.pkl
    └── torchvision
        └── models
            ├── resnet.py
            └── utils.py

您还可以使用 has_file() 方法查询 Directory 对象。

importer_file_structure = importer.file_structure()
found: bool = importer_file_structure.has_file("package_a/subpackage.py")

查看为什么包含某个模块作为依赖项？¶

假设有一个给定的模块foo，你想知道为什么你的PackageExporter将其作为依赖项引入。

PackageExporter.get_rdeps() 将返回所有直接依赖于foo的模块。

如果你想了解给定模块src如何依赖于foo，PackageExporter.all_paths() 方法将返回一个 DOT 格式的图，显示src和foo之间所有依赖路径。

如果你只想查看PackageExporter的整个依赖关系图，可以使用PackageExporter.dependency_graph_string()。

如何在包中包含任意资源并在以后访问它们？¶

PackageExporter公开了三个方法，save_pickle、save_text和save_binary，允许你将 Python 对象、文本和二进制数据保存到包中。

with torch.PackageExporter("package.pt") as exporter:
    # Pickles the object and saves to `my_resources/tensor.pkl` in the archive.
    exporter.save_pickle("my_resources", "tensor.pkl", torch.randn(4))
    exporter.save_text("config_stuff", "words.txt", "a sample string")
    exporter.save_binary("raw_data", "binary", my_bytes)

PackageImporter公开了名为load_pickle、load_text和load_binary的互补方法，允许你从包中加载 Python 对象、文本和二进制数据。

importer = torch.PackageImporter("package.pt")
my_tensor = importer.load_pickle("my_resources", "tensor.pkl")
text = importer.load_text("config_stuff", "words.txt")
binary = importer.load_binary("raw_data", "binary")

如何自定义类的打包方式？¶

torch.package允许自定义类的打包方式。此行为通过在类上定义方法__reduce_package__以及定义相应的解包函数来访问。这类似于为 Python 的正常pickle过程定义__reduce__。

步骤

在目标类上定义方法__reduce_package__(self, exporter: PackageExporter)。此方法应完成将类实例保存到包中的工作，并应返回一个元组，该元组包含相应的解包函数以及调用解包函数所需的参数。当PackageExporter遇到目标类的实例时，将调用此方法。
为类定义解包函数。此解包函数应完成重建和返回类实例的工作。函数签名的第一个参数应为PackageImporter实例，其余参数由用户定义。

# foo.py [Example of customizing how class Foo is packaged]
from torch.package import PackageExporter, PackageImporter
import time


class Foo:
    def __init__(self, my_string: str):
        super().__init__()
        self.my_string = my_string
        self.time_imported = 0
        self.time_exported = 0

    def __reduce_package__(self, exporter: PackageExporter):
        """
        Called by ``torch.package.PackageExporter``'s Pickler's ``persistent_id`` when
        saving an instance of this object. This method should do the work to save this
        object inside of the ``torch.package`` archive.

        Returns function w/ arguments to load the object from a
        ``torch.package.PackageImporter``'s Pickler's ``persistent_load`` function.
        """

        # use this pattern to ensure no naming conflicts with normal dependencies,
        # anything saved under this module name shouldn't conflict with other
        # items in the package
        generated_module_name = f"foo-generated._{exporter.get_unique_id()}"
        exporter.save_text(
            generated_module_name,
            "foo.txt",
            self.my_string + ", with exporter modification!",
        )
        time_exported = time.clock_gettime(1)

        # returns de-packaging function w/ arguments to invoke with
        return (unpackage_foo, (generated_module_name, time_exported,))


def unpackage_foo(
    importer: PackageImporter, generated_module_name: str, time_exported: float
) -> Foo:
    """
    Called by ``torch.package.PackageImporter``'s Pickler's ``persistent_load`` function
    when depickling a Foo object.
    Performs work of loading and returning a Foo instance from a ``torch.package`` archive.
    """
    time_imported = time.clock_gettime(1)
    foo = Foo(importer.load_text(generated_module_name, "foo.txt"))
    foo.time_imported = time_imported
    foo.time_exported = time_exported
    return foo

# example of saving instances of class Foo

import torch
from torch.package import PackageImporter, PackageExporter
import foo

foo_1 = foo.Foo("foo_1 initial string")
foo_2 = foo.Foo("foo_2 initial string")
with PackageExporter('foo_package.pt') as pe:
    # save as normal, no extra work necessary
    pe.save_pickle('foo_collection', 'foo1.pkl', foo_1)
    pe.save_pickle('foo_collection', 'foo2.pkl', foo_2)

pi = PackageImporter('foo_package.pt')
print(pi.file_structure())
imported_foo = pi.load_pickle('foo_collection', 'foo1.pkl')
print(f"foo_1 string: '{imported_foo.my_string}'")
print(f"foo_1 export time: {imported_foo.time_exported}")
print(f"foo_1 import time: {imported_foo.time_imported}")

# output of running above script
─── foo_package
    ├── foo-generated
    │   ├── _0
    │   │   └── foo.txt
    │   └── _1
    │       └── foo.txt
    ├── foo_collection
    │   ├── foo1.pkl
    │   └── foo2.pkl
    └── foo.py

foo_1 string: 'foo_1 initial string, with reduction modification!'
foo_1 export time: 9857706.650140837
foo_1 import time: 9857706.652698385

如何在源代码中测试它是否在包内执行？¶

PackageImporter会将属性__torch_package__添加到它初始化的每个模块中。你的代码可以检查此属性是否存在，以确定它是否在打包的上下文中执行。

# In foo/bar.py:

if "__torch_package__" in dir():  # true if the code is being loaded from a package
    def is_in_package():
        return True

    UserException = Exception
else:
    def is_in_package():
        return False

    UserException = UnpackageableException

现在，代码将根据它是通过 Python 环境正常导入还是从torch.package导入而表现出不同的行为。

from foo.bar import is_in_package

print(is_in_package())  # False

loaded_module = PackageImporter(my_package).import_module("foo.bar")
loaded_module.is_in_package()  # True

警告：通常，拥有根据其是否打包而表现出不同行为的代码是不好的做法。这可能导致难以调试的问题，这些问题对如何导入代码很敏感。如果你的包旨在被大量使用，请考虑重构你的代码，使其无论如何加载都以相同的方式运行。

如何将代码修补到包中？¶

PackageExporter提供了一个save_source_string()方法，允许将任意 Python 源代码保存到选择的模块中。

with PackageExporter(f) as exporter:
    # Save the my_module.foo available in your current Python environment.
    exporter.save_module("my_module.foo")

    # This saves the provided string to my_module/foo.py in the package archive.
    # It will override the my_module.foo that was previously saved.
    exporter.save_source_string("my_module.foo", textwrap.dedent(
        """\
        def my_function():
            print('hello world')
        """
    ))

    # If you want to treat my_module.bar as a package
    # (e.g. save to `my_module/bar/__init__.py` instead of `my_module/bar.py)
    # pass is_package=True,
    exporter.save_source_string("my_module.bar",
                                "def foo(): print('hello')\n",
                                is_package=True)

importer = PackageImporter(f)
importer.import_module("my_module.foo").my_function()  # prints 'hello world'

如何从打包的代码中访问包内容？¶

PackageImporter实现了importlib.resources API，用于从包内访问资源。

with PackageExporter(f) as exporter:
    # saves text to my_resource/a.txt in the archive
    exporter.save_text("my_resource", "a.txt", "hello world!")
    # saves the tensor to my_pickle/obj.pkl
    exporter.save_pickle("my_pickle", "obj.pkl", torch.ones(2, 2))

    # see below for module contents
    exporter.save_module("foo")
    exporter.save_module("bar")

importlib.resources API 允许从打包的代码中访问资源。

# foo.py:
import importlib.resources
import my_resource

# returns "hello world!"
def get_my_resource():
    return importlib.resources.read_text(my_resource, "a.txt")

使用importlib.resources是从打包的代码中访问包内容的推荐方法，因为它符合 Python 标准。但是，也可以从打包的代码中访问父PackageImporter实例本身。

# bar.py:
import torch_package_importer # this is the PackageImporter that imported this module.

# Prints "hello world!", equivalent to importlib.resources.read_text
def get_my_resource():
    return torch_package_importer.load_text("my_resource", "a.txt")

# You also do things that the importlib.resources API does not support, like loading
# a pickled object from the package.
def get_my_pickle():
    return torch_package_importer.load_pickle("my_pickle", "obj.pkl")

如何区分打包的代码和未打包的代码？¶

要判断对象的代码是否来自torch.package，可以使用torch.package.is_from_package()函数。注意：如果对象来自一个包，但其定义来自一个标记为extern的模块或来自stdlib，则此检查将返回False。

importer = PackageImporter(f)
mod = importer.import_module('foo')
obj = importer.load_pickle('model', 'model.pkl')
txt = importer.load_text('text', 'my_test.txt')

assert is_from_package(mod)
assert is_from_package(obj)
assert not is_from_package(txt) # str is from stdlib, so this will return False

如何重新导出导入的对象？¶

要重新导出之前由PackageImporter导入的对象，必须使新的PackageExporter了解原始的PackageImporter，以便它可以找到对象依赖项的源代码。

importer = PackageImporter(f)
obj = importer.load_pickle("model", "model.pkl")

# re-export obj in a new package
with PackageExporter(f2, importer=(importer, sys_importer)) as exporter:
    exporter.save_pickle("model", "model.pkl", obj)

如何打包 TorchScript 模块？¶

要打包 TorchScript 模型，请使用与其他任何对象相同的save_pickle和load_pickle API。保存作为属性或子模块的 TorchScript 对象也受支持，无需额外工作。

# save TorchScript just like any other object
with PackageExporter(file_name) as e:
    e.save_pickle("res", "script_model.pkl", scripted_model)
    e.save_pickle("res", "mixed_model.pkl", python_model_with_scripted_submodule)
# load as normal
importer = PackageImporter(file_name)
loaded_script = importer.load_pickle("res", "script_model.pkl")
loaded_mixed = importer.load_pickle("res", "mixed_model.pkl"

解释 ¶

`torch.package` 格式概述 ¶

torch.package文件是一个 ZIP 归档文件，通常使用.pt扩展名。在 ZIP 归档文件中，有两种文件

框架文件，放置在.data/中。
用户文件，即所有其他文件。

例如，这是来自torchvision的完整打包 ResNet 模型的样子

resnet
├── .data  # All framework-specific data is stored here.
│   │      # It's named to avoid conflicts with user-serialized code.
│   ├── 94286146172688.storage  # tensor data
│   ├── 94286146172784.storage
│   ├── extern_modules  # text file with names of extern modules (e.g. 'torch')
│   ├── version         # version metadata
│   ├── ...
├── model  # the pickled model
│   └── model.pkl
└── torchvision  # all code dependencies are captured as source files
    └── models
        ├── resnet.py
        └── utils.py

框架文件¶

.data/目录由 torch.package 拥有，其内容被视为私有实现细节。torch.package格式不对.data/的内容做出任何保证，但所做的任何更改都将向后兼容（即，较新版本的 PyTorch 始终能够加载较旧的torch.packages）。

目前，.data/目录包含以下项目

version：序列化格式的版本号，以便torch.package导入基础设施知道如何加载此包。
extern_modules：被视为extern的模块列表。extern模块将使用加载环境的系统导入器进行导入。
*.storage：序列化张量数据。

.data
├── 94286146172688.storage
├── 94286146172784.storage
├── extern_modules
├── version
├── ...

用户文件¶

归档文件中的所有其他文件都是由用户放置的。布局与 Python 常规包相同。要深入了解 Python 打包的工作原理，请参阅这篇论文（它略微过时，因此请使用Python 参考文档仔细检查实现细节）。

<package root>
├── model  # the pickled model
│   └── model.pkl
├── another_package
│   ├── __init__.py
│   ├── foo.txt         # a resource file , see importlib.resources
│   └── ...
└── torchvision
    └── models
        ├── resnet.py   # torchvision.models.resnet
        └── utils.py    # torchvision.models.utils

`torch.package`如何查找代码的依赖项 ¶

分析对象的依赖项¶

当您发出 save_pickle(obj, ...) 调用时，PackageExporter 会像往常一样对对象进行 pickle 操作。然后，它使用 pickletools 标准库模块来解析 pickle 字节码。

在 pickle 中，对象会与一个 GLOBAL 操作码一起保存，该操作码描述了在哪里可以找到对象类型的实现，例如

GLOBAL 'torchvision.models.resnet Resnet`

依赖关系解析器将收集所有 GLOBAL 操作，并将它们标记为您的 pickle 对象的依赖关系。有关 pickling 和 pickle 格式的更多信息，请查阅 Python 文档。

分析模块的依赖关系¶

当一个 Python 模块被识别为依赖关系时，torch.package 会遍历该模块的 Python AST 表示，并查找导入语句，并完全支持标准形式：from x import y、import z、from w import v as u 等。当遇到这些导入语句之一时，torch.package 会将导入的模块注册为依赖关系，然后以相同的 AST 遍历方式解析这些依赖关系。

注意：AST 解析对 __import__(...) 语法支持有限，并且不支持 importlib.import_module 调用。一般来说，您不应期望 torch.package 检测到动态导入。

依赖关系管理 ¶

torch.package 自动查找您的代码和对象依赖的 Python 模块。此过程称为依赖关系解析。对于依赖关系解析器找到的每个模块，您必须指定要采取的操作。

允许的操作包括

intern：将此模块放入包中。
extern：将此模块声明为包的外部依赖关系。
mock：模拟此模块。
deny：依赖此模块将在包导出期间引发错误。

最后，还有一个重要的操作，从技术上讲它不是 torch.package 的一部分

重构：删除或更改代码中的依赖关系。

请注意，操作仅定义在整个 Python 模块上。无法仅打包模块中的函数或类，而将其余部分排除在外。这是设计使然。Python 没有在模块中定义的对象之间提供清晰的边界。唯一定义的依赖项组织单元是模块，因此 torch.package 使用的是模块。

使用模式将操作应用于模块。模式可以是模块名称（"foo.bar"）或通配符（如 "foo.**"）。您可以使用 PackageExporter 上的方法将模式与操作关联起来，例如

my_exporter.intern("torchvision.**")
my_exporter.extern("numpy")

如果模块与模式匹配，则将相应的操作应用于它。对于给定的模块，将按定义的顺序检查模式，并将采取第一个操作。

`intern`¶

如果一个模块被 intern-ed，它将被放入包中。

此操作是您的模型代码，或您想要打包的任何相关代码。例如，如果您尝试打包来自 torchvision 的 ResNet，则需要 intern 模块 torchvision.models.resnet。

在包导入时，当打包的代码尝试导入一个 intern-ed 模块时，PackageImporter 将在您的包中查找该模块。如果找不到该模块，则会引发错误。这确保了每个 PackageImporter 与加载环境隔离——即使您在包和加载环境中都提供了 my_interned_module，PackageImporter 也只会使用包中的版本。

注意：只有 Python 源代码模块可以被 intern-ed。如果您尝试 intern 其他类型的模块（如 C 扩展模块和字节码模块），则会引发错误。这些类型的模块需要被 mock-ed 或 extern-ed。

`extern`¶

如果一个模块被 extern-ed，它将不会被打包。相反，它将被添加到此包的外部依赖关系列表中。您可以在 package_exporter.extern_modules 上找到此列表。

在包导入时，当打包的代码尝试导入一个 extern-ed 模块时，PackageImporter 将使用默认的 Python 导入器来查找该模块，就像您执行 importlib.import_module("my_externed_module") 一样。如果找不到该模块，则会引发错误。

这样，您就可以在包中依赖第三方库（如 numpy 和 scipy），而无需将它们也打包。

警告：如果任何外部库以向后不兼容的方式更改，您的包可能无法加载。如果您需要包的长期可重复性，请尽量限制 extern 的使用。

`mock`¶

如果一个模块被 mock-ed，它将不会被打包。相反，一个存根模块将被打包到其位置。存根模块将允许您从中检索对象（以便 from my_mocked_module import foo 不会出错），但是对该对象的任何使用都将引发 NotImplementedError。

mock 应该用于您“知道”在加载的包中不需要的代码，但您仍然希望在非打包的内容中可以使用。例如，初始化/配置代码，或仅用于调试/训练的代码。

警告：一般来说，mock 应该作为最后的手段使用。它在打包代码和非打包代码之间引入了行为差异，这可能会导致以后的混淆。最好重构代码以删除不需要的依赖关系。

重构¶

管理依赖关系的最佳方法是根本没有依赖关系！通常，可以重构代码以删除不必要的依赖关系。以下是一些编写具有清晰依赖关系的代码的指南（通常也是良好的实践！）

仅包含您使用的内容。不要在代码中留下未使用的导入。依赖关系解析器不够智能，无法判断它们确实是未使用的，并且会尝试处理它们。

限定您的导入。例如，不要编写 import foo 并在以后使用 foo.bar.baz，而是首选编写 from foo.bar import baz。这更精确地指定了您的实际依赖关系（foo.bar），并让依赖关系解析器知道您不需要所有 foo。

将具有无关功能的大文件拆分为较小的文件。如果您的 utils 模块包含各种无关的功能，则依赖于 utils 的任何模块都需要引入大量无关的依赖关系，即使您只需要其中的一小部分。最好定义单一用途的模块，这些模块可以彼此独立地打包。

模式¶

模式允许您使用方便的语法指定模块组。模式的语法和行为遵循 Bazel/Buck glob()。

我们尝试与模式匹配的模块称为候选者。候选者由以分隔符字符串分隔的段列表组成，例如 foo.bar.baz。

模式包含一个或多个段。段可以是

一个文字字符串（例如 foo），它完全匹配。
包含通配符的字符串（例如 torch 或 foo*baz*）。通配符匹配任何字符串，包括空字符串。
双通配符（**）。这与零个或多个完整段匹配。

示例

torch.**：匹配 torch 及其所有子模块，例如 torch.nn 和 torch.nn.functional。
torch.*：匹配 torch.nn 或 torch.functional，但不匹配 torch.nn.functional 或 torch
torch*.**: 匹配 torch、torchvision 及其所有子模块

在指定操作时，您可以传递多个模式，例如：

exporter.intern(["torchvision.models.**", "torchvision.utils.**"])

如果模块与任何一个模式匹配，则该模块将匹配此操作。

您还可以指定要排除的模式，例如：

exporter.mock("**", exclude=["torchvision.**"])

如果模块与任何一个排除模式匹配，则该模块将不匹配此操作。在本例中，我们模拟了除 torchvision 及其子模块之外的所有模块。

当一个模块可能与多个操作匹配时，将执行第一个定义的操作。

`torch.package` 尖锐边缘 ¶

避免在模块中使用全局状态¶

Python 使绑定对象并在模块级作用域运行代码变得非常容易。这通常没问题——毕竟，函数和类都是以这种方式绑定到名称的。但是，当您在模块作用域定义一个对象并打算对其进行修改，引入可变全局状态时，事情就会变得更加复杂。

可变全局状态非常有用——它可以减少样板代码，允许在表中进行开放注册等。但是，除非非常小心地使用，否则在与 torch.package 一起使用时可能会导致复杂问题。

每个 PackageImporter 为其内容创建独立的环境。这很好，因为这意味着我们可以加载多个包并确保它们彼此隔离，但是当模块以假设共享可变全局状态的方式编写时，此行为可能会导致难以调试的错误。

类型在包和加载环境之间不共享¶

您从 PackageImporter 导入的任何类都将是特定于该导入器的类的版本。例如

from foo import MyClass

my_class_instance = MyClass()

with PackageExporter(f) as exporter:
    exporter.save_module("foo")

importer = PackageImporter(f)
imported_MyClass = importer.import_module("foo").MyClass

assert isinstance(my_class_instance, MyClass)  # works
assert isinstance(my_class_instance, imported_MyClass)  # ERROR!

在本例中，MyClass 和 imported_MyClass 不是同一种类型。在此特定示例中，MyClass 和 imported_MyClass 具有完全相同的实现，因此您可能认为将它们视为同一个类是可以的。但请考虑 imported_MyClass 来自具有完全不同 MyClass 实现的旧包的情况——在这种情况下，将它们视为同一个类是不安全的。

在幕后，每个导入器都有一个前缀，允许它唯一地识别类

print(MyClass.__name__)  # prints "foo.MyClass"
print(imported_MyClass.__name__)  # prints <torch_package_0>.foo.MyClass

这意味着当其中一个参数来自包而另一个参数不来自包时，您不应该期望 isinstance 检查正常工作。如果您需要此功能，请考虑以下选项

进行鸭子类型检查（只使用类而不显式检查它是否为给定类型）。
使类型关系成为类契约的显式部分。例如，您可以添加一个属性标签 self.handler = "handle_me_this_way"，并让客户端代码检查 handler 的值，而不是直接检查类型。

`torch.package` 如何使包彼此隔离 ¶

每个 PackageImporter 实例为其模块和对象创建一个独立的、隔离的环境。包中的模块只能导入其他打包的模块，或标记为 extern 的模块。如果您使用多个 PackageImporter 实例加载单个包，您将获得多个不交互的独立环境。

这是通过使用自定义导入器扩展 Python 的导入基础设施来实现的。 PackageImporter 提供与 importlib 导入器相同的核心 API；即，它实现了 import_module 和 __import__ 方法。

当您调用 PackageImporter.import_module() 时， PackageImporter 将构造并返回一个新模块，就像系统导入器一样。但是，PackageImporter 修补了返回的模块以使用 self（即该 PackageImporter 实例）通过在包中查找而不是搜索用户的 Python 环境来满足未来的导入请求。

混淆¶

为了避免混淆（“这个 foo.bar 对象是我的包中的那个，还是我的 Python 环境中的那个？”）， PackageImporter 会混淆所有导入模块的 __name__ 和 __file__，通过向它们添加一个混淆前缀。

对于 __name__，像 torchvision.models.resnet18 这样的名称将变成 <torch_package_0>.torchvision.models.resnet18。

对于 __file__，像 torchvision/models/resnet18.py 这样的名称将变成 <torch_package_0>.torchvision/modules/resnet18.py。

名称混淆有助于避免不同包之间模块名称的无意双关，并通过使堆栈跟踪和打印语句更清楚地显示它们是否引用打包的代码来帮助您调试。有关混淆的开发人员面向细节，请参阅 torch/package/ 中的 mangling.md。

API 参考 ¶

class torch.package.PackagingError(dependency_graph, debug=False)[source]¶

当导出包时出现问题时，将引发此异常。 PackageExporter 将尝试收集所有错误并一次性向您呈现。

class torch.package.EmptyMatchError[source]¶: 当模拟或外部模块标记为 allow_empty=False，并且在打包期间与任何模块都不匹配时，将引发此异常。

class torch.package.PackageExporter(f, importer=<torch.package.importer._SysImporter object>, debug=False)[source]¶

导出器允许您将代码包、腌制的 Python 数据以及任意二进制和文本资源写入自包含的包中。

导入可以以隔离的方式加载此代码，以便从包而不是正常的 Python 导入系统加载代码。这允许打包 PyTorch 模型代码和数据，以便可以在服务器上运行或将来用于迁移学习。

包中包含的代码在创建时会从原始源逐文件复制，文件格式是经过特殊组织的 zip 文件。包的未来用户可以解压缩包，并编辑代码以对其进行自定义修改。

包的导入器确保模块中的代码只能从包内部加载，除了使用 extern() 显式列为外部的模块。zip 存档中的 extern_modules 文件列出了包外部依赖的所有模块。这可以防止“隐式”依赖，其中包在本地运行是因为它正在导入本地安装的包，但在将包复制到另一台机器时失败。

当源代码添加到包中时，导出器可以选择性地扫描它以查找更多代码依赖项（dependencies=True）。它查找导入语句，将相对引用解析为限定模块名称，并执行用户指定的操作（参见：extern()、mock() 和 intern()）。

__init__(f, importer=<torch.package.importer._SysImporter object>, debug=False)[source]¶

创建导出器。

参数

f (Union[str, Path, BinaryIO]) – 导出到的位置。可以是包含文件名的string/Path对象或二进制I/O对象。
importer (Union[Importer, Sequence[Importer]]) – 如果传递单个Importer，则使用它来搜索模块。如果传递了一系列导入器，则将从中构造一个OrderedImporter。
debug (bool) – 如果设置为True，则将损坏模块的路径添加到PackagingErrors。

add_dependency(module_name, dependencies=True)[source]¶

给定一个模块，根据用户指定的模式将其添加到依赖关系图中。

all_paths(src, dst)[source]¶

返回子图的点表示: 它具有从src到dst的所有路径。

返回值: 包含从src到dst的所有路径的点表示。（https://graphviz.org/doc/info/lang.html)
返回类型: str

close()[source]¶

将包写入文件系统。在close()之后的所有调用现在都无效。最好使用资源保护语法代替

with PackageExporter("file.zip") as e:
    ...

denied_modules()[source]¶

返回当前被拒绝的所有模块。

返回值: 包含将在此包中被拒绝的模块名称的列表。
返回类型: List[str]

deny(include, *, exclude=())[source]¶

将名称与给定glob模式匹配的模块列入黑名单，从包可以导入的模块列表中排除。如果发现对任何匹配包的依赖关系，则会引发PackagingError。

参数

include (Union[List[str], str]) – 字符串，例如"my_package.my_subpackage"，或要外部化的模块名称的字符串列表。这也可以是glob样式的模式，如mock()中所述。
exclude (Union[List[str], str]) – 一个可选模式，排除与include字符串匹配的一些模式。

dependency_graph_string()[source]¶

返回包中依赖项的图字符串表示。

返回值: 包中依赖项的字符串表示。
返回类型: str

extern(include, *, exclude=(), allow_empty=True)[source]¶

将module包含在包可以导入的外部模块列表中。这将阻止依赖关系发现将其保存在包中。导入器将直接从标准导入系统加载外部模块。extern模块的代码也必须存在于加载包的进程中。

参数

include (Union[List[str], str]) – 字符串，例如"my_package.my_subpackage"，或要外部化的模块名称的字符串列表。这也可以是glob样式的模式，如mock()中所述。
exclude (Union[List[str], str]) – 一个可选模式，排除与include字符串匹配的一些模式。
allow_empty (bool) – 一个可选标志，指定此调用对extern方法指定的extern模块是否必须在打包期间与某些模块匹配。如果使用allow_empty=False添加了extern模块glob模式，并且在任何模块匹配该模式之前调用了close()（显式或通过__exit__），则会抛出异常。如果allow_empty=True，则不会抛出此类异常。

externed_modules()[source]¶

返回当前所有外部化的模块。

返回值: 包含将在此包中外部化的模块名称的列表。
返回类型: List[str]

get_rdeps(module_name)[source]¶

返回依赖于模块module_name的所有模块的列表。

返回值: 包含依赖于module_name的模块名称的列表。
返回类型: List[str]

get_unique_id()[source]¶

获取ID。此ID保证仅为此包分发一次。

返回类型: str

intern(include, *, exclude=(), allow_empty=True)[source]¶

指定应打包的模块。模块必须与某些intern模式匹配才能包含在包中并对其依赖项进行递归处理。

参数

include (Union[List[str], str]) – 字符串，例如“my_package.my_subpackage”，或要外部化的模块名称的字符串列表。这也可以是glob样式的模式，如mock()中所述。
exclude (Union[List[str], str]) – 一个可选模式，排除与include字符串匹配的一些模式。
allow_empty (bool) – 一个可选标志，指定此调用对intern方法指定的intern模块是否必须在打包期间与某些模块匹配。如果使用allow_empty=False添加了intern模块glob模式，并且在任何模块匹配该模式之前调用了close()（显式或通过__exit__），则会抛出异常。如果allow_empty=True，则不会抛出此类异常。

interned_modules()[source]¶

返回当前所有内部化的模块。

返回值: 包含将在此包中内部化的模块名称的列表。
返回类型: List[str]

mock(include, *, exclude=(), allow_empty=True)[source]¶

用模拟实现替换一些必需的模块。模拟的模块将为从中访问的任何属性返回一个伪对象。因为我们是逐个复制文件，所以依赖项解析有时会找到模型文件导入但其功能从未使用过的文件（例如自定义序列化代码或训练助手）。使用此函数模拟此功能，而无需修改原始代码。

参数

include (Union[List[str], str]) –
一个字符串，例如 "my_package.my_subpackage"，或要模拟的模块名称的字符串列表。字符串也可以是 glob 样式的模式字符串，它可能匹配多个模块。任何与该模式字符串匹配的必需依赖项都将自动模拟。

示例
'torch.**' – 匹配 torch 和 torch 的所有子模块，例如 'torch.nn' 和 'torch.nn.functional'

'torch.*' – 匹配 'torch.nn' 或 'torch.functional'，但不匹配 'torch.nn.functional'
exclude (Union[List[str], str]) – 一个可选模式，用于排除与 include 字符串匹配的一些模式。例如 include='torch.**', exclude='torch.foo' 将模拟所有 torch 包，除了 'torch.foo'，默认值：为 []。
allow_empty (bool) – 一个可选标志，指定此对 mock() 方法的调用的模拟实现必须在打包期间与某些模块匹配。如果使用 allow_empty=False 添加模拟，并且调用了 close()（显式或通过 __exit__），并且模拟尚未与正在导出的包使用的模块匹配，则会抛出异常。如果 allow_empty=True，则不会抛出此类异常。

mocked_modules()[source]¶

返回当前所有被模拟的模块。

返回值: 一个包含将在该包中模拟的模块名称的列表。
返回类型: List[str]

register_extern_hook(hook)[source]¶

在导出器上注册一个 extern hook。

每次模块与 extern() 模式匹配时，都会调用该 hook。它应该具有以下签名

hook(exporter: PackageExporter, module_name: str) -> None

将按注册顺序调用 Hook。

返回值: 一个句柄，可用于通过调用 handle.remove() 删除添加的 hook。
返回类型: torch.utils.hooks.RemovableHandle

register_intern_hook(hook)[source]¶

在导出器上注册一个 intern hook。

每次模块与 intern() 模式匹配时，都会调用该 hook。它应该具有以下签名

hook(exporter: PackageExporter, module_name: str) -> None

将按注册顺序调用 Hook。

返回值: 一个句柄，可用于通过调用 handle.remove() 删除添加的 hook。
返回类型: torch.utils.hooks.RemovableHandle

register_mock_hook(hook)[source]¶

在导出器上注册一个 mock hook。

每次模块与 mock() 模式匹配时，都会调用该 hook。它应该具有以下签名

hook(exporter: PackageExporter, module_name: str) -> None

将按注册顺序调用 Hook。

返回值: 一个句柄，可用于通过调用 handle.remove() 删除添加的 hook。
返回类型: torch.utils.hooks.RemovableHandle

save_binary(package, resource, binary)[source]¶

将原始字节保存到包中。

参数

package (str) – 此资源应所在的模块包的名称（例如 "my_package.my_subpackage"）。
resource (str) – 资源的唯一名称，用于识别它以进行加载。
binary (str) – 要保存的数据。

save_module(module_name, dependencies=True)[source]¶

将 module 的代码保存到包中。模块的代码使用 importers 路径来查找模块对象，然后使用其 __file__ 属性来查找源代码。

参数

module_name (str) – 例如 my_package.my_subpackage，代码将被保存以提供此包的代码。
dependencies (bool, optional) – 如果为 True，我们将扫描源代码以查找依赖项。

save_pickle(package, resource, obj, dependencies=True, pickle_protocol=3)[source]¶

使用 pickle 将 Python 对象保存到存档中。等效于 torch.save()，但保存到存档而不是独立文件中。标准 pickle 不会保存代码，只会保存对象。如果 dependencies 为真，此方法还将扫描已腌制对象以查找重建它们所需的模块并保存相关代码。

为了能够保存一个对象，其中 type(obj).__name__ 为 my_module.MyObject，my_module.MyObject 必须根据 importer 顺序解析为对象的类。在保存先前已打包的对象时，需要在 importer 列表中提供导入器的 import_module 方法才能使其工作。

参数

package (str) – 此资源应所在的模块包的名称（例如 "my_package.my_subpackage"）。
resource (str) – 资源的唯一名称，用于识别它以进行加载。
obj (Any) – 要保存的对象，必须是可腌制的。
dependencies (bool, optional) – 如果为 True，我们将扫描源代码以查找依赖项。

save_source_file(module_name, file_or_directory, dependencies=True)[source]¶

将本地文件系统 file_or_directory 添加到源包，以提供 module_name 的代码。

参数

module_name (str) – 例如 "my_package.my_subpackage"，代码将被保存以提供此包的代码。
文件或目录 (str) – 代码文件或目录的路径。如果是目录，则使用 save_source_file() 递归复制目录中的所有 Python 文件。如果文件名为 "/__init__.py"，则代码将被视为一个包。
dependencies (bool, optional) – 如果为 True，我们将扫描源代码以查找依赖项。

save_source_string(module_name, src, is_package=False, dependencies=True)[source]¶

将 src 作为导出包中 module_name 的源代码添加。

参数

module_name (str) – 例如 my_package.my_subpackage，代码将被保存以提供此包的代码。
src (str) – 要为此包保存的 Python 源代码。
is_package (bool, optional) – 如果为 True，则此模块将被视为一个包。包允许具有子模块（例如 my_package.my_subpackage.my_subsubpackage），并且可以在其中保存资源。默认为 False。
dependencies (bool, optional) – 如果为 True，我们将扫描源代码以查找依赖项。

save_text(package, resource, text)[source]¶

将文本数据保存到包中。

参数

package (str) – 此资源应所在的模块包的名称（例如 "my_package.my_subpackage"）。
resource (str) – 资源的唯一名称，用于识别它以进行加载。
text (str) – 要保存的内容。

class torch.package.PackageImporter(file_or_buffer, module_allowed=<function PackageImporter.<lambda>>)[source]¶

导入器允许您加载由 PackageExporter 编写的包中的代码。代码以隔离的方式加载，使用包中的文件而不是正常的 Python 导入系统。这允许打包 PyTorch 模型代码和数据，以便可以在服务器上运行或将来用于迁移学习。

包的导入器确保模块中的代码只能从包内加载，除了在导出期间明确列为外部的模块。zip 存档中的 extern_modules 文件列出了包外部依赖的所有模块。这可以防止“隐式”依赖关系，即包在本地运行是因为它正在导入本地安装的包，但在将包复制到另一台机器时会失败。

__init__(file_or_buffer, module_allowed=<function PackageImporter.<lambda>>)[source]¶

打开 file_or_buffer 以进行导入。这会检查导入的包是否仅需要 module_allowed 允许的模块。

参数

file_or_buffer (Union[str, PyTorchFileReader, PathLike, BinaryIO]) – 类文件对象（必须实现 read()、readline()、tell() 和 seek()）、字符串或包含文件名的 os.PathLike 对象。
module_allowed (Callable[[str], bool], optional) – 用于确定是否应允许外部提供的模块的方法。可用于确保加载的包不依赖服务器不支持的模块。默认为允许任何模块。

引发

ImportError – 如果包将使用不允许的模块。

file_structure(*, include='**', exclude=())[source]¶

返回包的 zip 文件的表示文件结构。

参数

include (Union[List[str], str]) – 可选字符串，例如 "my_package.my_subpackage"，或者要包含在 zip 文件表示中的文件的名称的可选字符串列表。这也可以是 glob 样式的模式，如 PackageExporter.mock() 中所述。
exclude (Union[List[str], str]) – 可选模式，排除名称与模式匹配的文件。

返回值

目录

返回类型

id()[source]¶

返回 PackageImporter 实例区分使用的内部标识符。类似于

<torch_package_0>

import_module(name, package=None)[source]¶

如果模块尚未加载，则从包中加载模块，然后返回该模块。模块在导入器本地加载，并将显示在 self.modules 而不是 sys.modules 中。

参数

name (str) – 要加载的模块的完整限定名称。
package ([type], optional) – 未使用，但存在以匹配 importlib.import_module 的签名。默认为 None。

返回值

（可能已）加载的模块。

返回类型

types.ModuleType

load_binary(package, resource)[source]¶

加载原始字节。

参数

package (str) – 模块包的名称（例如 "my_package.my_subpackage"）。
resource (str) – 资源的唯一名称。

返回值

加载的数据。

返回类型

bytes

load_pickle(package, resource, map_location=None)[source]¶

从包中取消资源的序列化，使用 import_module() 加载构建对象所需的任何模块。

参数

package (str) – 模块包的名称（例如 "my_package.my_subpackage"）。
resource (str) – 资源的唯一名称。
map_location – 传递给 torch.load 以确定张量如何映射到设备。默认为 None。

返回值

取消序列化的对象。

返回类型

Any

load_text(package, resource, encoding='utf-8', errors='strict')[source]¶

加载字符串。

参数

package (str) – 模块包的名称（例如 "my_package.my_subpackage"）。
resource (str) – 资源的唯一名称。
encoding (str, optional) – 传递给 decode。默认为 'utf-8'。
错误 (str, 可选) – 传递给 decode。默认为 'strict'。

返回值

加载的文本。

返回类型

str

python_version()[source]¶

返回用于创建此包的 Python 版本。

注意：此函数为实验性，不具备前向兼容性。计划稍后将其移至锁定文件中。

返回值: Optional[str] Python 版本，例如 3.8.9，如果此包未存储版本，则为 None

class torch.package.Directory(name, is_dir)[source]¶

文件结构表示。组织为包含其目录子项列表的目录节点。包的目录是通过调用 PackageImporter.file_structure() 创建的。

has_file(filename)[source]¶

检查 Directory 中是否存在文件。

参数: filename (str) – 要搜索的文件路径。
返回值: 如果 Directory 包含指定的文件。
返回类型: bool

torch.package¶

将软件包视为 ZIP 存档¶

使用 file_structure() API¶

框架文件¶

用户文件¶

分析对象的依赖项¶

分析模块的依赖关系¶

intern¶

extern¶

mock¶

重构¶

模式¶

避免在模块中使用全局状态¶

类型在包和加载环境之间不共享¶

混淆¶

文档

教程

资源

使用 `file_structure()` API¶

`intern`¶

`extern`¶

`mock`¶