Skip to content

Commit 0e5f309

Browse files
authored
Test MV3 model in CI wheel builds (#9192)
### Summary As part of #9019, we want to ensure we can export models on P0 hosts targeting P0 backends. So, let's test this in our wheel creation. For now, we introduce macOS/Linux XNNPACK export. Given the wheel building GitHub workflow doesn't support using jobs as a test step, we must go use a python script. This runs a similar test to what we do in PRs: https://github.com/pytorch/executorch/blob/1011fdc98bcd61063b845670fb1779635aa30e3a/.github/workflows/pull.yml#L85-L136 ### Test plan CI → Build {Linux, macOS} Wheels cc @larryliu0820 @lucylq
1 parent 2e1dadf commit 0e5f309

File tree

14 files changed

+202
-179
lines changed

14 files changed

+202
-179
lines changed

.ci/scripts/wheel/__init__.py

Whitespace-only changes.

.ci/scripts/wheel/envvar_linux.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Copyright (c) Meta Platforms, Inc. and affiliates.
2+
# All rights reserved.
3+
#
4+
# This source code is licensed under the BSD-style license found in the
5+
# LICENSE file in the root directory of this source tree.
6+
7+
# This file is sourced into the environment before building a pip wheel. It
8+
# should typically only contain shell variable assignments. Be sure to export
9+
# any variables so that subprocesses will see them.
10+
11+
source "${GITHUB_WORKSPACE}/${REPOSITORY}/.ci/scripts/wheel/envvar_base.sh"

build/packaging/env_var_script_macos.sh renamed to .ci/scripts/wheel/envvar_macos.sh

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,7 @@
88
# should typically only contain shell variable assignments. Be sure to export
99
# any variables so that subprocesses will see them.
1010

11-
# Enable pybindings so that users can execute ExecuTorch programs from python.
12-
export EXECUTORCH_BUILD_PYBIND=1
13-
14-
# Ensure that CMAKE_ARGS is defined before referencing it. Defaults to empty
15-
# if not defined.
16-
export CMAKE_ARGS="${CMAKE_ARGS:-}"
17-
18-
# Link the XNNPACK backend into the pybindings runtime so that users can execute
19-
# ExecuTorch programs that delegate to it.
20-
CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_XNNPACK=ON"
11+
source "${GITHUB_WORKSPACE}/${REPOSITORY}/.ci/scripts/wheel/envvar_base.sh"
2112

2213
# When building for macOS, link additional backends into the pybindings runtime.
2314
CMAKE_ARGS="${CMAKE_ARGS} -DEXECUTORCH_BUILD_COREML=ON"

build/packaging/pre_build_script.sh renamed to .ci/scripts/wheel/pre_build_script.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ set -euxo pipefail
1414
# which does install them. Though we'd need to disable build isolation to be
1515
# able to see the installed torch package.
1616

17-
pip install --progress-bar off -r requirements-dev.txt
17+
"${GITHUB_WORKSPACE}/${REPOSITORY}/install_requirements.sh"

.ci/scripts/wheel/test_base.py

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Copyright (c) Meta Platforms, Inc. and affiliates.
2+
# All rights reserved.
3+
#
4+
# This source code is licensed under the BSD-style license found in the
5+
# LICENSE file in the root directory of this source tree.
6+
7+
import os
8+
import subprocess
9+
import sys
10+
from dataclasses import dataclass
11+
from functools import cache
12+
from typing import List
13+
14+
15+
@cache
16+
def _unsafe_get_env(key: str) -> str:
17+
value = os.getenv(key)
18+
if value is None:
19+
raise RuntimeError(f"environment variable '{key}' is not set")
20+
return value
21+
22+
23+
@cache
24+
def _repository_root_dir() -> str:
25+
return os.path.join(
26+
_unsafe_get_env("GITHUB_WORKSPACE"),
27+
_unsafe_get_env("REPOSITORY"),
28+
)
29+
30+
31+
# For some reason, we are unable to see the entire repo in the python path.
32+
# So manually add it.
33+
sys.path.append(_repository_root_dir())
34+
from examples.models import Backend, Model
35+
36+
37+
@dataclass
38+
class ModelTest:
39+
model: Model
40+
backend: Backend
41+
42+
43+
def run_tests(model_tests: List[ModelTest]) -> None:
44+
# Why are we doing this envvar shenanigans? Since we build the testers, which
45+
# uses buck, we cannot run as root. This is a sneaky of getting around that
46+
# test.
47+
#
48+
# This can be reverted if either:
49+
# - We remove usage of buck in our builds
50+
# - We stop running the Docker image as root: https://github.com/pytorch/test-infra/issues/5091
51+
envvars = os.environ.copy()
52+
envvars.pop("HOME")
53+
54+
for model_test in model_tests:
55+
subprocess.run(
56+
[
57+
os.path.join(_repository_root_dir(), ".ci/scripts/test_model.sh"),
58+
str(model_test.model),
59+
# What to build `executor_runner` with for testing.
60+
"cmake",
61+
str(model_test.backend),
62+
],
63+
env=envvars,
64+
check=True,
65+
cwd=_repository_root_dir(),
66+
)

.ci/scripts/wheel/test_linux.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#!/usr/bin/env python
2+
# Copyright (c) Meta Platforms, Inc. and affiliates.
3+
# All rights reserved.
4+
#
5+
# This source code is licensed under the BSD-style license found in the
6+
# LICENSE file in the root directory of this source tree.
7+
8+
import test_base
9+
from examples.models import Backend, Model
10+
11+
if __name__ == "__main__":
12+
test_base.run_tests(
13+
model_tests=[
14+
test_base.ModelTest(
15+
model=Model.Mv3,
16+
backend=Backend.XnnpackQuantizationDelegation,
17+
)
18+
]
19+
)

.ci/scripts/wheel/test_macos.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#!/usr/bin/env python
2+
# Copyright (c) Meta Platforms, Inc. and affiliates.
3+
# All rights reserved.
4+
#
5+
# This source code is licensed under the BSD-style license found in the
6+
# LICENSE file in the root directory of this source tree.
7+
8+
import test_base
9+
from examples.models import Backend, Model
10+
11+
if __name__ == "__main__":
12+
test_base.run_tests(
13+
model_tests=[
14+
test_base.ModelTest(
15+
model=Model.Mv3,
16+
backend=Backend.XnnpackQuantizationDelegation,
17+
)
18+
]
19+
)

.github/workflows/build-wheels-linux.yml

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: Build Linux Wheels
44
on:
55
pull_request:
66
paths:
7-
- build/packaging/**
7+
- .ci/**/*
88
- .github/workflows/build-wheels-linux.yml
99
push:
1010
branches:
@@ -39,9 +39,9 @@ jobs:
3939
matrix:
4040
include:
4141
- repository: pytorch/executorch
42-
pre-script: build/packaging/pre_build_script.sh
43-
post-script: build/packaging/post_build_script.sh
44-
smoke-test-script: build/packaging/smoke_test.py
42+
pre-script: .ci/scripts/wheel/pre_build_script.sh
43+
post-script: .ci/scripts/wheel/post_build_script.sh
44+
smoke-test-script: .ci/scripts/wheel/test_linux.py
4545
package-name: executorch
4646
name: ${{ matrix.repository }}
4747
uses: pytorch/test-infra/.github/workflows/build_wheels_linux.yml@main
@@ -51,11 +51,8 @@ jobs:
5151
test-infra-repository: pytorch/test-infra
5252
test-infra-ref: main
5353
build-matrix: ${{ needs.generate-matrix.outputs.matrix }}
54-
# ExecuTorch only needs the first layer of submodules; override the
55-
# "recursive" default to do less work, and to give the buck daemon fewer
56-
# files to look at.
57-
submodules: true
58-
env-var-script: build/packaging/env_var_script_linux.sh
54+
submodules: recursive
55+
env-var-script: .ci/scripts/wheel/envvar_linux.sh
5956
pre-script: ${{ matrix.pre-script }}
6057
post-script: ${{ matrix.post-script }}
6158
package-name: ${{ matrix.package-name }}

.github/workflows/build-wheels-macos.yml

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: Build macOS Wheels
44
on:
55
pull_request:
66
paths:
7-
- build/packaging/**
7+
- .ci/**/*
88
- .github/workflows/build-wheels-macos.yml
99
push:
1010
branches:
@@ -39,9 +39,9 @@ jobs:
3939
matrix:
4040
include:
4141
- repository: pytorch/executorch
42-
pre-script: build/packaging/pre_build_script.sh
43-
post-script: build/packaging/post_build_script.sh
44-
smoke-test-script: build/packaging/smoke_test.py
42+
pre-script: .ci/scripts/wheel/pre_build_script.sh
43+
post-script: .ci/scripts/wheel/post_build_script.sh
44+
smoke-test-script: .ci/scripts/wheel/test_macos.py
4545
package-name: executorch
4646
name: ${{ matrix.repository }}
4747
uses: pytorch/test-infra/.github/workflows/build_wheels_macos.yml@main
@@ -51,12 +51,9 @@ jobs:
5151
test-infra-repository: pytorch/test-infra
5252
test-infra-ref: main
5353
build-matrix: ${{ needs.generate-matrix.outputs.matrix }}
54-
# ExecuTorch only needs the first layer of submodules; override the
55-
# "recursive" default to do less work, and to give the buck daemon fewer
56-
# files to look at.
57-
submodules: true
54+
submodules: recursive
5855
delocate-wheel: false
59-
env-var-script: build/packaging/env_var_script_macos.sh
56+
env-var-script: .ci/scripts/wheel/envvar_macos.sh
6057
pre-script: ${{ matrix.pre-script }}
6158
post-script: ${{ matrix.post-script }}
6259
package-name: ${{ matrix.package-name }}

build/packaging/smoke_test.py

Lines changed: 0 additions & 121 deletions
This file was deleted.

0 commit comments

Comments
 (0)