executorch 0.1.0__tar.gz → 0.1.2__tar.gz

executorch-0.1.2/LICENSE

@@ -0,0 +1,33 @@
+BSD License
+
+For "ExecuTorch" software
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+Copyright 2023 Arm Limited and/or its affiliates.
+Copyright (c) Qualcomm Innovation Center, Inc.
+Copyright (c) 2023 Apple Inc.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+ * Neither the name Meta nor the names of its contributors may be used to
+   endorse or promote products derived from this software without specific
+   prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{executorch-0.1.0 → executorch-0.1.2}/PKG-INFO

@@ -1,3 +1,4 @@
 Metadata-Version: 2.1
 Name: executorch
-Version: 0.1.0
+Version: 0.1.2
+License-File: LICENSE

executorch-0.1.2/README.md

@@ -0,0 +1,87 @@
+# ExecuTorch
+
+**ExecuTorch** is an end-to-end solution for enabling on-device inference
+capabilities across mobile and edge devices including wearables, embedded
+devices and microcontrollers. It is part of the PyTorch Edge ecosystem and
+enables efficient deployment of PyTorch models to edge devices.
+
+Key value propositions of ExecuTorch are:
+
+- **Portability:** Compatibility with a wide variety of computing platforms,
+  from high-end mobile phones to highly constrained embedded systems and
+  microcontrollers.
+- **Productivity:** Enabling developers to use the same toolchains and SDK from
+  PyTorch model authoring and conversion, to debugging and deployment to a wide
+  variety of platforms.
+- **Performance:** Providing end users with a seamless and high-performance
+  experience due to a lightweight runtime and utilizing full hardware
+  capabilities such as CPUs, NPUs, and DSPs.
+
+For a comprehensive technical overview of ExecuTorch and step-by-step tutorials,
+please visit our [documentation website](https://pytorch.org/executorch).
+
+## Important: This is a preview release
+
+This is a preview version of ExecuTorch and should be used for testing and evaluation purposes only.
+It is not recommended for use in production settings. We welcome any feedback, suggestions, and bug
+reports from the community to help us improve the technology.
+Please use the [PyTorch Forums](https://discuss.pytorch.org/) for discussion
+and feedback about ExecuTorch using the tag **#executorch** and
+our [GitHub repository](https://github.com/pytorch/executorch/issues)
+for bug reporting.
+
+The ExecuTorch code and APIs are still changing quickly, and there are not yet
+any guarantees about forward/backward source compatibility. We recommend using
+the latest `v#.#.#` release tag from the
+[Releases](https://github.com/pytorch/executorch/releases) page when
+experimenting with this preview release.
+
+## Directory Structure
+
+```
+executorch
+├── backends                        #  Backend delegate implementations.
+├── build                           #  Utilities for managing the build system.
+├── bundled_program                 #  Utilities for attaching reference inputs and outputs to models. TODO move to extension
+├── codegen                         #  Tooling to autogenerate bindings between kernels and the runtime. TODO move to tool
+├── configurations                  #  TODO delete this
+├── docs                            #  Static docs tooling
+├── examples                        #  Examples of various user flows, such as model export, delegates, and runtime execution.
+├── exir                            #  Ahead of time library, model capture and lowering apis.
+|   ├── 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.
+|   ├── program                     #  Export artifacts.
+|   ├── serialize                   #  Serialize final export artifact.
+├── extension                       #  Extensions built on top of the runtime.
+|   ├── aten_util
+|   ├── data_loader                 # 1st party data loader implementations.
+|   ├── memory_allocator            # 1st party memory allocator implementations.
+|   ├── pybindings                  # Python api for executorch runtime.
+|   ├── pytree                      # C++ and Python flattening and unflattening lib for pytrees.
+|   ├── testing_util
+├── kernels                         #  1st party kernel implementations.
+|   ├── aten
+|   ├── optimized
+|   ├── portable                    #  Reference implementations of ATen operators.
+|   ├── prim_ops                    #  Special ops used in executorch runtime for control flow and symbolic primitives.
+|   ├── quantized
+├── profiler                        #  Utilities for profiling. TODO delete in favor of ETDump in sdk/
+├── runtime                         #  core cpp runtime of executorch
+|   ├── backend                     #  Backend delegate runtime APIs
+|   ├── core                        #  Core structures used across all levels of the runtime
+|   ├── 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/
+├── scripts                         #  Utility scripts for size management, dependency management, etc.
+├── sdk                             #  Model profiling, debugging, and introspection.
+├── shim                            #  Compatibility layer between OSS and Internal builds
+├── test                            #  Broad scoped end2end tests
+├── third-party                     #  third-party dependencies
+├── util                            #  TODO delete this
+```
+
+## License
+ExecuTorch is BSD licensed, as found in the LICENSE file.

executorch-0.1.2/backends/apple/coreml/compiler/__init__.py

@@ -0,0 +1,9 @@
+# Copyright © 2023 Apple Inc. All rights reserved.
+#
+# Please refer to the license found in the LICENSE file in the root directory of the source tree.
+
+from .coreml_preprocess import CoreMLBackend
+
+__all__ = [
+    CoreMLBackend,
+]

executorch-0.1.2/backends/apple/coreml/compiler/coreml_preprocess.py

@@ -0,0 +1,76 @@
+#  Copyright © 2023 Apple Inc. All rights reserved.
+
+# CoreML backend for delegating a EdgeProgram to CoreML.
+
+import json
+import shutil
+import uuid
+
+from pathlib import Path
+
+from typing import final, List
+
+import coremltools as ct
+import executorchcoreml
+
+from executorch.exir.backend.backend_details import (
+    BackendDetails,
+    ExportedProgram,
+    PreprocessResult,
+)
+from executorch.exir.backend.compile_spec_schema import CompileSpec
+
+
+@final
+class CoreMLBackend(BackendDetails):
+    @staticmethod
+    def to_bytes(mlmodel):
+        dir_path = Path("tmp")
+        model_dir_path = dir_path / "lowered_module"
+        Path(model_dir_path).mkdir(parents=True, exist_ok=True)
+        model_path = model_dir_path / "model.mlpackage"
+        mlmodel.save(model_path)
+
+        # save model metdata
+        spec = mlmodel.get_spec()
+        input_names = [input.name for input in spec.description.input]
+        output_names = [output.name for output in spec.description.output]
+        identifier = uuid.uuid4()
+
+        model_metadata = {
+            "inputNames": input_names,
+            "outputNames": output_names,
+            "identifier": str(identifier),
+        }
+
+        # store metadata
+        model_metadata_path = Path(model_dir_path) / "metadata.json"
+        json_object = json.dumps(model_metadata)
+        with open(model_metadata_path, "w") as outfile:
+            outfile.write(json_object)
+
+        # flatten directory contents and convert it to bytes
+        flattened_bytes = executorchcoreml.flatten_directory_contents(
+            str(model_dir_path.resolve())
+        )
+        shutil.rmtree(str(model_dir_path.resolve()))
+        return flattened_bytes
+
+    @classmethod
+    # pyre-ignore
+    def preprocess(
+        cls,
+        edge_program: ExportedProgram,
+        module_compile_spec: List[CompileSpec],
+    ) -> PreprocessResult:
+        mlmodel = ct.convert(
+            model=edge_program,
+            source="pytorch",
+            convert_to="mlprogram",
+            pass_pipeline=ct.PassPipeline.DEFAULT,
+            skip_model_load=True,
+        )
+        flattened_bytes = CoreMLBackend.to_bytes(mlmodel)
+        return PreprocessResult(
+            processed_bytes=flattened_bytes,
+        )

executorch-0.1.2/backends/apple/coreml/runtime/inmemoryfs/setup.py

@@ -0,0 +1,49 @@
+import os
+
+import pathlib
+import sys
+
+REPO_ROOT = pathlib.Path(__file__).resolve().parent.parent.parent.parent.parent.parent
+PYBIND11_DIR_PATH = REPO_ROOT / "third-party" / "pybind11"
+sys.path.append(str(PYBIND11_DIR_PATH.absolute()))
+
+from pybind11.setup_helpers import build_ext, Pybind11Extension
+from setuptools import setup
+
+__version__ = "0.0.1"
+
+cxx_std = int(os.environ.get("CMAKE_CXX_STANDARD", "17"))
+
+ext_modules = [
+    Pybind11Extension(
+        "executorchcoreml",
+        [
+            "inmemory_filesystem.cpp",
+            "inmemory_filesystem_py.cpp",
+            "memory_buffer.cpp",
+            "memory_stream.cpp",
+            "reversed_memory_stream.cpp",
+        ],
+        define_macros=[("VERSION_INFO", __version__)],
+        cxx_std=cxx_std,
+        extra_compile_args=["-mmacosx-version-min=10.15"],
+        include_dirs=[
+            "../../third-party/nlohmann_json/single_include/nlohmann",
+            ".",
+        ],
+    ),
+]
+
+setup(
+    name="executorchcoreml",
+    version=__version__,
+    description="CoreML extension for executorch",
+    long_description="",
+    author="Apple Inc.",
+    ext_modules=ext_modules,
+    extras_require={"test": "pytest"},
+    cmdclass={"build_ext": build_ext},
+    include_package_data=True,
+    zip_safe=False,
+    python_requires=">=3.9",
+)