Merge branch 'pytorch:main' into main

Author: Jerry-Ge

.ci/docker/README.md

@@ -1,7 +1,7 @@
-# Docker images for Executorch CI
+# Docker images for ExecuTorch CI
 
 This directory contains everything needed to build the Docker images
-that are used in Executorch CI. The content of this directory are copied
+that are used in ExecuTorch CI. The content of this directory are copied
 from PyTorch CI https://github.com/pytorch/pytorch/tree/main/.ci/docker.
 It also uses the same directory structure as PyTorch.
 

.ci/docker/conda-env-ci.txt

@@ -1,4 +1 @@
-# TODO: We might need to update this to install flatbuffers from the pinned commit
-# in fbcode/executorch/third-party/flatbuffers.submodule.txt
-flatbuffers=2.0.0
 cmake=3.22.1

.ci/scripts/gather_test_models.py

@@ -23,6 +23,7 @@
     "ic4": "linux.12xlarge",
     "resnet50": "linux.12xlarge",
     # This one causes timeout on smaller runner, the root cause is unclear (T161064121)
+    "dl3": "linux.12xlarge",
     "emformer_join": "linux.12xlarge",
 }
 

.ci/scripts/setup-linux.sh

@@ -20,5 +20,6 @@ fi
 
 # As Linux job is running inside a Docker container, all of its dependencies
 # have already been installed
+install_flatc_from_source
 install_executorch
 build_executorch_runner "${BUILD_TOOL}"

.ci/scripts/setup-macos.sh

@@ -80,5 +80,6 @@ install_buck
 install_conda
 install_pip_dependencies
 print_cmake_info
+install_flatc_from_source
 install_executorch
 build_executorch_runner "${BUILD_TOOL}"

.ci/scripts/utils.sh

@@ -27,7 +27,7 @@ install_executorch() {
 install_conda() {
   pushd .ci/docker || return
   # Install conda dependencies like flatbuffer
-  conda install --file conda-env-ci.txt
+  conda install -y --file conda-env-ci.txt
   popd || return
 }
 
@@ -49,6 +49,25 @@ install_pip_dependencies() {
   popd || return
 }
 
+install_flatc_from_source() {
+  # NB: This function could be used to install flatbuffer from source
+  pushd third-party/flatbuffers || return
+
+  cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release
+  if [ "$(uname)" == "Darwin" ]; then
+    CMAKE_JOBS=$(( $(sysctl -n hw.ncpu) - 1 ))
+  else
+    CMAKE_JOBS=$(( $(nproc) - 1 ))
+  fi
+  cmake --build . -j "${CMAKE_JOBS}"
+
+  # Copy the flatc binary to conda path
+  EXEC_PATH=$(dirname "$(which python)")
+  cp flatc "${EXEC_PATH}"
+
+  popd || return
+}
+
 build_executorch_runner_buck2() {
   # Build executorch runtime with retry as this step is flaky on macos CI
   retry buck2 build //examples/executor_runner:executor_runner

.github/workflows/_unittest.yml

@@ -15,6 +15,10 @@ on:
 jobs:
   linux:
     uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
+    strategy:
+      matrix:
+        include:
+          - build-tool: buck2
     with:
       runner: linux.2xlarge
       docker-image: ${{ inputs.docker-image }}
@@ -28,8 +32,10 @@ jobs:
         CONDA_ENV=$(conda env list --json | jq -r ".envs | .[-1]")
         conda activate "${CONDA_ENV}"
 
-        # Just need to install executorch, everything else has been setup
-        pip install .
+        BUILD_TOOL=${{ matrix.build-tool }}
+        # Setup MacOS dependencies as there is no Docker support on MacOS atm
+        PYTHON_EXECUTABLE=python bash .ci/scripts/setup-linux.sh "${BUILD_TOOL}"
+
         # Run pytest with coverage
         pytest -n auto --cov=./ --cov-report=xml
 
@@ -53,8 +59,6 @@ jobs:
         # Setup MacOS dependencies as there is no Docker support on MacOS atm
         PYTHON_EXECUTABLE=python bash .ci/scripts/setup-macos.sh "${BUILD_TOOL}"
 
-        # Just need to install executorch, everything else has been setup
-        pip install .
         # Run pytest with coverage
         pytest -n auto --cov=./ --cov-report=xml
         # Run gtest

.github/workflows/doc-build.yml

@@ -16,28 +16,33 @@ on:
 jobs:
   build:
     uses: pytorch/test-infra/.github/workflows/linux_job.yml@main
+    strategy:
+      matrix:
+        include:
+          - build-tool: buck2
     with:
       job-name: Build doc
       runner: linux.2xlarge
       docker-image: executorch-ubuntu-22.04-clang12
-      fetch-depth: 0
       submodules: 'true'
       repository: pytorch/executorch
       upload-artifact: docs
-
       script: |
-        # Set up Environment Variables
-        PYTHON_VERSION=3.10
-        export PATH="/opt/conda/envs/py_${PYTHON_VERSION}/bin:${PATH}"
+        # The generic Linux job chooses to use base env, not the one setup by the image
+        CONDA_ENV=$(conda env list --json | jq -r ".envs | .[-1]")
+        conda activate "${CONDA_ENV}"
+
+        BUILD_TOOL=${{ matrix.build-tool }}
+        # Setup MacOS dependencies as there is no Docker support on MacOS atm
+        PYTHON_EXECUTABLE=python bash .ci/scripts/setup-linux.sh "${BUILD_TOOL}"
 
         if [[(${GITHUB_EVENT_NAME} = 'pull_request' && (${GITHUB_BASE_REF} = 'release'*)) || (${GITHUB_REF} = 'refs/heads/release'*) ]]; then
           export CHANNEL=test
         else
           export CHANNEL=nightly
         fi
 
-        set -ex
-        set +u
+        set -eux
 
         # Build docset:
         cd docs
@@ -48,7 +53,6 @@ jobs:
 
         # Sometimes the artifact directory already contains an "html" subdir.
         rm -rf "${RUNNER_ARTIFACT_DIR}/html"
-
         mv docs/_build/html "${RUNNER_ARTIFACT_DIR}"
 
 # Enable preview later. Previews are available publicly

.github/workflows/pull.yml

@@ -130,12 +130,12 @@ jobs:
       ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
       script: |
         WORKSPACE=$(pwd)
-
         pushd "${WORKSPACE}/pytorch/executorch"
 
         BUILD_TOOL=${{ matrix.build-tool }}
         # Setup MacOS dependencies as there is no Docker support on MacOS atm
         PYTHON_EXECUTABLE=python bash .ci/scripts/setup-macos.sh "${BUILD_TOOL}"
+
         # Build and test custom ops
         PYTHON_EXECUTABLE=python bash examples/custom_ops/test_custom_ops.sh "${BUILD_TOOL}"
         popd
@@ -179,12 +179,12 @@ jobs:
       ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
       script: |
         WORKSPACE=$(pwd)
-
         pushd "${WORKSPACE}/pytorch/executorch"
 
         BUILD_TOOL=${{ matrix.build-tool }}
         # Setup MacOS dependencies as there is no Docker support on MacOS atm
         PYTHON_EXECUTABLE=python bash .ci/scripts/setup-macos.sh "${BUILD_TOOL}"
+
         # Build and test selective build
         PYTHON_EXECUTABLE=python bash examples/selective_build/test_selective_build.sh "${BUILD_TOOL}"
         popd

.lintrunner.toml

@@ -122,3 +122,34 @@ init_command = [
     '--dry-run={{DRYRUN}}',
     '--requirement=requirements-lintrunner.txt',
 ]
+
+[[linter]]
+code = 'ETCAPITAL'
+include_patterns = [
+    '**/*.py',
+    '**/*.pyi',
+    '**/*.h',
+    '**/*.cpp',
+    '**/*.md',
+    '**/*.rst',
+]
+exclude_patterns = [
+    'third-party/**',
+    '**/third-party/**',
+]
+command = [
+    'python',
+    '-m',
+    'lintrunner_adapters',
+    'run',
+    'grep_linter',
+    '--pattern= Executorch\W+',
+    '--linter-name=ExecuTorchCapitalization',
+    '--error-name=Incorrect capitalization for ExecuTorch',
+    """--error-description=
+    Please use ExecuTorch with capital T for consistency.
+    https://fburl.com/workplace/nsx6hib2
+    """,
+    '--',
+    '@{{PATHSFILE}}',
+]

CONTRIBUTING.md

@@ -113,7 +113,7 @@ must work with threading**
 ## For Delegate Authors
 
 * Use [this](/docs/website/docs/contributors/delegates.md)
-guide when integrating your delegate with Executorch.
+guide when integrating your delegate with ExecuTorch.
 
 * Refer to [this](/docs/website/docs/contributors/delegates_and_dependencies.md)
 set of guidelines when including a 3p depenency for your delegate.

README.md

@@ -39,13 +39,13 @@ Compared to the legacy Lite Interpreter, there are some major benefits:
 
 - [Setting up ExecuTorch from GitHub](/docs/website/docs/tutorials/00_setting_up_executorch.md)
     - (Optional) [Building with CMake](/docs/website/docs/tutorials/cmake_build_system.md)
-- [Exporting to Executorch](/docs/website/docs/tutorials/exporting_to_executorch.md)
+- [Exporting to ExecuTorch](/docs/website/docs/tutorials/exporting_to_executorch.md)
     - [EXIR Spec](/docs/website/docs/ir_spec/00_exir.md)
     - [Exporting manual](/docs/website/docs/export/00_export_manual.md)
     - [Quantization](/docs/website/docs/tutorials/quantization_flow.md)
     - [Delegate to a backend](/docs/website/docs/tutorials/backend_delegate.md)
     - [Profiling](/docs/website/docs/tutorials/profiling.md)
-- [Executorch Google Colab](https://colab.research.google.com/drive/1m8iU4y7CRVelnnolK3ThS2l2gBo7QnAP#scrollTo=1o2t3LlYJQY5)
+- [ExecuTorch Google Colab](https://colab.research.google.com/drive/1m8iU4y7CRVelnnolK3ThS2l2gBo7QnAP#scrollTo=1o2t3LlYJQY5)
 
 ## Directory Structure [WIP]
 
@@ -67,7 +67,7 @@ executorch
 |   ├── backend                     #  Backend delegate ahead of time APIs
 |   ├── capture                     #  Program capture.
 |   ├── dialects                    #  Op sets for various dialects in the export process.
-|   ├── emit                        #  Conversion from ExportedProgram to Executorch execution instructions.
+|   ├── emit                        #  Conversion from ExportedProgram to ExecuTorch execution instructions.
 |   ├── program                     #  Export artifacts.
 |   ├── serialize                   #  Serialize final export artifact.
 ├── extension                       #  Extensions built on top of the runtime.
@@ -90,7 +90,7 @@ executorch
 |   ├── executor                    #  Model loading, initalization, and execution.
 |   ├── kernel                      #  Kernel registration and management.
 |   ├── platform                    #  Layer between architecture specific code and user calls.
-├── schema                          #  Executorch program definition, TODO move under serialization/
+├── schema                          #  ExecuTorch program definition, TODO move under serialization/
 ├── scripts                         #  Utility scripts for size management, dependency management, etc.
 ├── sdk                             #  Model profiling, debugging, and introspection: NOT READY YET FOR OSS USE
 ├── shim                            #  Compatibility layer between OSS and Internal builds

backends/arm/README.md

@@ -1,6 +1,6 @@
-# Executorch Arm/TOSA Delegate
+# ExecuTorch Arm/TOSA Delegate
 
-This subtree contains the Arm Delegate implementation for Executorch.
+This subtree contains the Arm Delegate implementation for ExecuTorch.
 
 This delegate is structured to, over time, support a number of different Arm devices
 through an AoT flow which targets multiple Arm IP using the TOSA standard.

backends/tosa/test/test_tosa_example.py

@@ -1,6 +1,6 @@
-# Executorch XNNPACK Delegate
+# ExecuTorch XNNPACK Delegate
 
-This subtree contains the XNNPACK Delegate implementation for Executorch.
+This subtree contains the XNNPACK Delegate implementation for ExecuTorch.
 XNNPACK is an optimized library of neural network inference operators for ARM
 and x86 CPUs. It is an open source project used by PyTorch. The delegate is the
 mechanism for leveraging the XNNPACK library to accelerate operators running on

backends/xnnpack/README.md

@@ -8,6 +8,7 @@
 
 #include <executorch/backends/xnnpack/runtime/utils/utils.h>
 #include <executorch/runtime/platform/assert.h>
+#include <cinttypes>
 
 namespace torch {
 namespace executor {
@@ -170,8 +171,8 @@ std::pair<float, float> GetMinMax(const Tensor& ft) {
   float max = -std::numeric_limits<float>::max();
   ET_CHECK_MSG(
       ft.scalar_type() == ScalarType::Float,
-      "Expected float tensor but got %hhd",
-      ft.scalar_type());
+      "Expected float tensor but got %" PRId8,
+      static_cast<int8_t>(ft.scalar_type()));
   const float* d = ft.const_data_ptr<float>();
   for (int i = 0; i < ft.numel(); ++i) {
     min = (d[i] < min) ? d[i] : min;

backends/xnnpack/runtime/utils/utils.cpp

@@ -359,7 +359,7 @@ def run_method(self, method="forward"):
         delegated_module = self.get_artifact(self._stage_name(Partition))
         self.reference_output = delegated_module(*self.inputs)
 
-        # Executorch
+        # ExecuTorch
         inputs_flattened, _ = tree_flatten(self.inputs)
         serialized_buffer = self.get_artifact(self._stage_name(Serialize))
         executorch_module = _load_for_executorch_from_buffer(serialized_buffer)

backends/xnnpack/test/tester/tester.py

@@ -86,6 +86,9 @@ buck_targets = [
 filters = [
   ".cpp$",
 ]
+deps = [
+  "executorch",
+]
 
 [targets.xnn_executor_runner]
 buck_targets = [

build/cmake_deps.toml

@@ -84,7 +84,7 @@ class BundledExecutionPlanTest:
 
 @dataclass
 class BundledProgram:
-    """Executorch program bunlded with data for verification."""
+    """ExecuTorch program bunlded with data for verification."""
 
     # Schema version.
     version: int
@@ -94,5 +94,5 @@ class BundledProgram:
     # Its length should be equal to the number of execution plans in program.
     execution_plan_tests: List[BundledExecutionPlanTest]
 
-    # The binary data of a serialized Executorch program.
+    # The binary data of a serialized ExecuTorch program.
     program: bytes

bundled_program/schema.py

@@ -16,8 +16,8 @@
 def main(argv: List[Any]) -> None:
     """This binary is a wrapper for //xplat/caffe2/tools/code_analyzer/gen_oplist.py.
     This is needed because we intend to error out for the case where `model_file_list_path`
-    is empty or invalid, so that the Executorch build will fail when no selective build target
-    is provided as a dependency to Executorch build.
+    is empty or invalid, so that the ExecuTorch build will fail when no selective build target
+    is provided as a dependency to ExecuTorch build.
     """
     parser = argparse.ArgumentParser(description="Generate operator lists")
     parser.add_argument(
@@ -66,7 +66,7 @@ def main(argv: List[Any]) -> None:
             model_file_names = model_list_file.read().split()
             assert (
                 len(model_file_names) > 0
-            ), "BUCK was not able to find any `et_operator_library` in the dependency graph of the current Executorch "
+            ), "BUCK was not able to find any `et_operator_library` in the dependency graph of the current ExecuTorch "
             "build. Please refer to Selective Build wiki page to add at least one."
     gen_oplist.main(argv)
 

codegen/tools/gen_all_oplist.py

@@ -63,7 +63,7 @@ def dump_yaml(model_file: str, output_file: str) -> None:
 
 
 def main(args: List[Any]) -> None:
-    """This binary generates a template functions.yaml which will be consumed by Executorch codegen.
+    """This binary generates a template functions.yaml which will be consumed by ExecuTorch codegen.
     It reads the model file, deserialize it and dumps all the operators into a new functions.yaml.
     The generated file contains placeholder kernels, it needs to be updated with proper kernel names.
     """

codegen/tools/gen_ops_def.py

@@ -251,7 +251,7 @@ with open(save_path, "wb") as f:
 
 ## Runtime
 
-The serialized flatbuffer model is loaded by the Executorch runtime. The
+The serialized flatbuffer model is loaded by the ExecuTorch runtime. The
 preprocessed blob is directly stored in the flatbuffer, which is loaded into a
 call to the backend's `init()` function during model initialization stage. At
 the model execution stage, the initialized handled can be executed through the

docs/source/_static/img/how-executorch-works-high-level.png

@@ -71,7 +71,7 @@
 sphinx_gallery_conf = {
     "examples_dirs": ["tutorials_source"],
     "gallery_dirs": ["tutorials"],
-    "filename_pattern": "/tutorials/",
+    "filename_pattern": "/tutorials_source/",
     "promote_jupyter_magic": True,
     "backreferences_dir": None,
     "first_notebook_cell": ("%matplotlib inline"),
@@ -90,6 +90,10 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+# autosectionlabel throws warnings if section names are duplicated.
+# The following tells autosectionlabel to not throw a warning for
+# duplicated section names that are in different documents.
+autosectionlabel_prefix_document = True
 
 # -- Options for HTML output -------------------------------------------------