Bundled Program – ExecuTorch 模型验证工具¶

介绍¶

BundledProgram 是对核心 ExecuTorch 程序的一个包装，旨在帮助用户将其测试用例与部署的模型进行打包。 BundledProgram 不一定是程序的核心部分，也不需要用于其执行，但对于各种其他用例（例如模型正确性评估，包括模型启动过程中的端到端测试）却非常重要。

总的来说，该过程可以分为两个阶段，并且在每个阶段我们都提供支持：

Emit 阶段：将 I/O 测试用例与 ExecuTorch 程序一起打包，并序列化为 flatbuffer。
Runtime 阶段：在运行时访问、执行和验证已打包的测试用例。

Emit 阶段¶

此阶段主要侧重于创建 BundledProgram 并将其作为 flatbuffer 文件转储到磁盘。主要过程如下：

创建模型并发出其 ExecuTorch 程序。
构建一个 List[MethodTestSuite] 来记录所有需要打包的测试用例。
使用已发出的模型和 List[MethodTestSuite] 生成 BundledProgram。
将 BundledProgram 序列化并转储到磁盘。

步骤 1：创建模型并发出其 ExecuTorch 程序。¶

可以使用 ExecuTorch API 从用户模型中发出 ExecuTorch 程序。请遵循生成并发出示例 ExecuTorch 程序或导出到 ExecuTorch 教程。

步骤 2：构建 `List[MethodTestSuite]` 来保存测试信息¶

在 BundledProgram 中，我们创建了两个新类：MethodTestCase 和 MethodTestSuite，用于保存 ExecuTorch 程序验证所需的核心信息。

MethodTestCase 表示单个测试用例。每个 MethodTestCase 包含单次执行的输入和预期输出。

MethodTestSuite 包含单个方法的全部测试信息，包括一个表示方法名称的字符串，以及一个包含所有测试用例的 List[MethodTestCase]。

由于每个模型可能有多个推理方法，因此我们需要生成 List[MethodTestSuite] 来保存所有必需的信息。

步骤 3：生成 `BundledProgram`¶

我们在 executorch/devtools/bundled_program/core.py 下提供了 BundledProgram 类，用于将 ExecutorchProgram 类型的变量（包括 ExecutorchProgram、MultiMethodExecutorchProgram 或 ExecutorchProgramManager）与 List[MethodTestSuite] 打包在一起。

BundledProgram 的构造函数将进行内部健全性检查，以查看给定的 List[MethodTestSuite] 是否与给定的程序要求匹配。具体来说：

List[MethodTestSuite] 中每个 MethodTestSuite 的 method_names 应存在于程序中。请注意，不需要为程序中的每个方法设置测试用例。
每个测试用例的元数据应满足相应推理方法的输入要求。

步骤 4：将 `BundledProgram` 序列化为 Flatbuffer。¶

为了序列化 BundledProgram 以便运行时 API 使用，我们提供了两个 API，它们都位于 executorch/devtools/bundled_program/serialize/__init__.py 下。

Emit 示例¶

下面是一个流程，展示了如何给定一个 PyTorch 模型以及我们希望与之一起测试的代表性输入来生成 BundledProgram。

import torch

from executorch.exir import to_edge_transform_and_lower
from executorch.devtools import BundledProgram

from executorch.devtools.bundled_program.config import MethodTestCase, MethodTestSuite
from executorch.devtools.bundled_program.serialize import (
    serialize_from_bundled_program_to_flatbuffer,
)
from torch.export import export, export_for_training


# Step 1: ExecuTorch Program Export
class SampleModel(torch.nn.Module):
    """An example model with multi-methods. Each method has multiple input and single output"""

    def __init__(self) -> None:
        super().__init__()
        self.register_buffer('a', 3 * torch.ones(2, 2, dtype=torch.int32))
        self.register_buffer('b', 2 * torch.ones(2, 2, dtype=torch.int32))

    def forward(self, x: torch.Tensor, q: torch.Tensor) -> torch.Tensor:
        z = x.clone()
        torch.mul(self.a, x, out=z)
        y = x.clone()
        torch.add(z, self.b, out=y)
        torch.add(y, q, out=y)
        return y


# Inference method name of SampleModel we want to bundle testcases to.
# Notices that we do not need to bundle testcases for every inference methods.
method_name = "forward"
model = SampleModel()

# Inputs for graph capture.
capture_input = (
    (torch.rand(2, 2) - 0.5).to(dtype=torch.int32),
    (torch.rand(2, 2) - 0.5).to(dtype=torch.int32),
)

# Export method's FX Graph.
method_graph = export(
    export_for_training(model, capture_input).module(),
    capture_input,
)


# Emit the traced method into ET Program.
et_program = to_edge_transform_and_lower(method_graph).to_executorch()

# Step 2: Construct MethodTestSuite for Each Method

# Prepare the Test Inputs.

# Number of input sets to be verified
n_input = 10

# Input sets to be verified.
inputs = [
    # Each list below is a individual input set.
    # The number of inputs, dtype and size of each input follow Program's spec.
    [
        (torch.rand(2, 2) - 0.5).to(dtype=torch.int32),
        (torch.rand(2, 2) - 0.5).to(dtype=torch.int32),
    ]
    for _ in range(n_input)
]

# Generate Test Suites
method_test_suites = [
    MethodTestSuite(
        method_name=method_name,
        test_cases=[
            MethodTestCase(
                inputs=input,
                expected_outputs=(getattr(model, method_name)(*input), ),
            )
            for input in inputs
        ],
    ),
]

# Step 3: Generate BundledProgram
bundled_program = BundledProgram(et_program, method_test_suites)

# Step 4: Serialize BundledProgram to flatbuffer.
serialized_bundled_program = serialize_from_bundled_program_to_flatbuffer(
    bundled_program
)
save_path = "bundled_program.bpte"
with open(save_path, "wb") as f:
    f.write(serialized_bundled_program)

如果需要，我们也可以从 flatbuffer 文件重新生成 BundledProgram。

from executorch.devtools.bundled_program.serialize import deserialize_from_flatbuffer_to_bundled_program
save_path = "bundled_program.bpte"
with open(save_path, "rb") as f:
    serialized_bundled_program = f.read()

regenerate_bundled_program = deserialize_from_flatbuffer_to_bundled_program(serialized_bundled_program)

Runtime 阶段¶

此阶段主要侧重于使用打包的输入执行模型，并将模型的输出与打包的预期输出进行比较。我们提供了多个 API 来处理其中的关键部分。

从 `BundledProgram` 缓冲区获取 ExecuTorch 程序指针¶

我们需要 ExecuTorch 程序指针来进行执行。为了统一加载和执行 BundledProgram 和程序 flatbuffer 的过程，我们创建了一个 API executorch::bundled_program::get_program_data。请参阅该 API 的示例用法。

将打包输入加载到方法中¶

为了在打包输入上执行程序，我们需要将打包输入加载到方法中。这里我们提供了一个名为 executorch::bundled_program::load_bundled_input 的 API。请参阅该 API 的示例用法。

验证方法的输出。¶

我们调用 executorch::bundled_program::verify_method_outputs 来将方法的输出与打包的预期输出进行比较。请参阅该 API 的示例用法。

Runtime 示例¶

请查看我们的示例运行器以了解打包程序。您可以使用以下命令来测试在上一步中生成的 BundledProgram 二进制（.bpte）文件：

cd executorch
   ./examples/devtools/build_example_runner.sh
   ./cmake-out/examples/devtools/example_runner --bundled_program_path {your-bpte-file} --output_verification

运行上述代码片段预计不会产生任何输出。

有关运行器应如何工作的详细示例，请参阅我们的示例运行器。

常见错误¶

如果 List[MethodTestSuites] 与 Program 不匹配，将会引发错误。以下是两种常见情况：

测试输入不符合模型的要求。¶

PyTorch 模型的每个推理方法都有自己的输入要求，例如输入的数量、每个输入的 dtype 等。BundledProgram 如果测试输入不符合要求，将会引发错误。

以下是测试输入 dtype 不符合模型要求的示例：

import torch

from executorch.exir import to_edge
from executorch.devtools import BundledProgram

from executorch.devtools.bundled_program.config import MethodTestCase, MethodTestSuite
from torch.export import export, export_for_training


class Module(torch.nn.Module):
    def __init__(self):
        super().__init__()
        self.a = 3 * torch.ones(2, 2, dtype=torch.float)
        self.b = 2 * torch.ones(2, 2, dtype=torch.float)

    def forward(self, x):
        out_1 = torch.ones(2, 2, dtype=torch.float)
        out_2 = torch.ones(2, 2, dtype=torch.float)
        torch.mul(self.a, x, out=out_1)
        torch.add(out_1, self.b, out=out_2)
        return out_2


model = Module()
method_names = ["forward"]

inputs = (torch.ones(2, 2, dtype=torch.float), )

# Find each method of model needs to be traced my its name, export its FX Graph.
method_graph = export(
    export_for_training(model, inputs).module(),
    inputs,
)

# Emit the traced methods into ET Program.
et_program = to_edge(method_graph).to_executorch()

# number of input sets to be verified
n_input = 10

# Input sets to be verified for each inference methods.
# To simplify, here we create same inputs for all methods.
inputs = {
    # Inference method name corresponding to its test cases.
    m_name: [
        # NOTE: executorch program needs torch.float, but here is torch.int
        [
            torch.randint(-5, 5, (2, 2), dtype=torch.int),
        ]
        for _ in range(n_input)
    ]
    for m_name in method_names
}

# Generate Test Suites
method_test_suites = [
    MethodTestSuite(
        method_name=m_name,
        test_cases=[
            MethodTestCase(
                inputs=input,
                expected_outputs=(getattr(model, m_name)(*input),),
            )
            for input in inputs[m_name]
        ],
    )
    for m_name in method_names
]

# Generate BundledProgram

bundled_program = BundledProgram(et_program, method_test_suites)

引发的错误

The input tensor tensor([[-2,  0],
        [-2, -1]], dtype=torch.int32) dtype shall be torch.float32, but now is torch.int32
---------------------------------------------------------------------------
AssertionError                            Traceback (most recent call last)
Cell In[1], line 72
     56 method_test_suites = [
     57     MethodTestSuite(
     58         method_name=m_name,
   (...)
     67     for m_name in method_names
     68 ]
     70 # Step 3: Generate BundledProgram
---> 72 bundled_program = create_bundled_program(program, method_test_suites)
File /executorch/devtools/bundled_program/core.py:276, in create_bundled_program(program, method_test_suites)
    264 """Create bp_schema.BundledProgram by bundling the given program and method_test_suites together.
    265
    266 Args:
   (...)
    271     The `BundledProgram` variable contains given ExecuTorch program and test cases.
    272 """
    274 method_test_suites = sorted(method_test_suites, key=lambda x: x.method_name)
--> 276 assert_valid_bundle(program, method_test_suites)
    278 bundled_method_test_suites: List[bp_schema.BundledMethodTestSuite] = []
    280 # Emit data and metadata of bundled tensor
File /executorch/devtools/bundled_program/core.py:219, in assert_valid_bundle(program, method_test_suites)
    215 # type of tensor input should match execution plan
    216 if type(cur_plan_test_inputs[j]) == torch.Tensor:
    217     # pyre-fixme[16]: Undefined attribute [16]: Item `bool` of `typing.Union[bool, float, int, torch._tensor.Tensor]`
    218     # has no attribute `dtype`.
--> 219     assert cur_plan_test_inputs[j].dtype == get_input_dtype(
    220         program, program_plan_id, j
    221     ), "The input tensor {} dtype shall be {}, but now is {}".format(
    222         cur_plan_test_inputs[j],
    223         get_input_dtype(program, program_plan_id, j),
    224         cur_plan_test_inputs[j].dtype,
    225     )
    226 elif type(cur_plan_test_inputs[j]) in (
    227     int,
    228     bool,
    229     float,
    230 ):
    231     assert type(cur_plan_test_inputs[j]) == get_input_type(
    232         program, program_plan_id, j
    233     ), "The input primitive dtype shall be {}, but now is {}".format(
    234         get_input_type(program, program_plan_id, j),
    235         type(cur_plan_test_inputs[j]),
    236     )
AssertionError: The input tensor tensor([[-2,  0],
        [-2, -1]], dtype=torch.int32) dtype shall be torch.float32, but now is torch.int32

`BundleConfig` 中的方法名称不存在。¶

另一个常见错误是 MethodTestSuite 中的方法名称在模型中不存在。BundledProgram 将会引发错误并显示不存在的方法名称。

import torch

from executorch.exir import to_edge
from executorch.devtools import BundledProgram

from executorch.devtools.bundled_program.config import MethodTestCase, MethodTestSuite
from torch.export import export, export_for_training


class Module(torch.nn.Module):
    def __init__(self):
        super().__init__()
        self.a = 3 * torch.ones(2, 2, dtype=torch.float)
        self.b = 2 * torch.ones(2, 2, dtype=torch.float)

    def forward(self, x):
        out_1 = torch.ones(2, 2, dtype=torch.float)
        out_2 = torch.ones(2, 2, dtype=torch.float)
        torch.mul(self.a, x, out=out_1)
        torch.add(out_1, self.b, out=out_2)
        return out_2


model = Module()
method_names = ["forward"]

inputs = (torch.ones(2, 2, dtype=torch.float),)

# Find each method of model needs to be traced my its name, export its FX Graph.
method_graph = export(
    export_for_training(model, inputs).module(),
    inputs,
)

# Emit the traced methods into ET Program.
et_program = to_edge(method_graph).to_executorch()

# number of input sets to be verified
n_input = 10

# Input sets to be verified for each inference methods.
# To simplify, here we create same inputs for all methods.
inputs = {
    # Inference method name corresponding to its test cases.
    m_name: [
        [
            torch.randint(-5, 5, (2, 2), dtype=torch.float),
        ]
        for _ in range(n_input)
    ]
    for m_name in method_names
}

# Generate Test Suites
method_test_suites = [
    MethodTestSuite(
        method_name=m_name,
        test_cases=[
            MethodTestCase(
                inputs=input,
                expected_outputs=(getattr(model, m_name)(*input),),
            )
            for input in inputs[m_name]
        ],
    )
    for m_name in method_names
]

# NOTE: MISSING_METHOD_NAME is not an inference method in the above model.
method_test_suites[0].method_name = "MISSING_METHOD_NAME"

# Generate BundledProgram
bundled_program = BundledProgram(et_program, method_test_suites)

Bundled Program – ExecuTorch 模型验证工具¶

介绍¶

Emit 阶段¶

步骤 1：创建模型并发出其 ExecuTorch 程序。¶

步骤 2：构建 `List[MethodTestSuite]` 来保存测试信息¶

步骤 3：生成 `BundledProgram`¶

步骤 4：将 `BundledProgram` 序列化为 Flatbuffer。¶

Emit 示例¶

Runtime 阶段¶

从 `BundledProgram` 缓冲区获取 ExecuTorch 程序指针¶

将打包输入加载到方法中¶

验证方法的输出。¶

Runtime 示例¶

常见错误¶

测试输入不符合模型的要求。¶

`BundleConfig` 中的方法名称不存在。¶

文档

教程

资源

Bundled Program – ExecuTorch 模型验证工具¶

介绍¶

Emit 阶段¶

步骤 1：创建模型并发出其 ExecuTorch 程序。¶

步骤 2：构建 List[MethodTestSuite] 来保存测试信息¶

步骤 3：生成 BundledProgram¶

步骤 4：将 BundledProgram 序列化为 Flatbuffer。¶

Emit 示例¶

Runtime 阶段¶

从 BundledProgram 缓冲区获取 ExecuTorch 程序指针¶

将打包输入加载到方法中¶

验证方法的输出。¶

Runtime 示例¶

常见错误¶

测试输入不符合模型的要求。¶

BundleConfig 中的方法名称不存在。¶

文档

教程

资源

步骤 2：构建 `List[MethodTestSuite]` 来保存测试信息¶

步骤 3：生成 `BundledProgram`¶

步骤 4：将 `BundledProgram` 序列化为 Flatbuffer。¶

从 `BundledProgram` 缓冲区获取 ExecuTorch 程序指针¶

`BundleConfig` 中的方法名称不存在。¶