[WIP] OpenVINOQuantizer

CMakeLists.txt

@@ -196,6 +196,8 @@ option(EXECUTORCH_BUILD_MPS "Build the MPS backend" OFF)
 
 option(EXECUTORCH_BUILD_NEURON "Build the backends/mediatek directory" OFF)
 
+option(EXECUTORCH_BUILD_OPENVINO "Build the Openvino backend" ON)
+
 option(EXECUTORCH_BUILD_PYBIND "Build the Python Bindings" OFF)
 
 option(EXECUTORCH_BUILD_QNN "Build the Qualcomm backend" OFF)
@@ -663,6 +665,10 @@ if(EXECUTORCH_BUILD_NEURON)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/mediatek)
 endif()
 
+if(EXECUTORCH_BUILD_OPENVINO)
+  add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/openvino)
+endif()
+
 if(EXECUTORCH_BUILD_QNN)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/qualcomm)
 endif()

README.md

@@ -29,6 +29,7 @@ Platform Support:
   - Arm
   - Cadence
   - MediaTek
+  - OpenVINO
   - Qualcomm
   - Vulkan
   - XNNPACK

backends/openvino/CMakeLists.txt

@@ -0,0 +1,72 @@
+# Copyright (c) Intel Corporation
+#
+# Licensed under the BSD License (the "License"); you may not use this file
+# except in compliance with the License. See the license file in the root
+# directory of this source tree for more details.
+
+# Set minimum required CMake version
+cmake_minimum_required(VERSION 3.19)
+
+# Set project name
+project(openvino_backend_project)
+
+# Set C++ standard
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Ensure compile_commands.json is generated
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# Set up EXECUTORCH_ROOT if not already set
+if(NOT EXECUTORCH_ROOT)
+  set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../..)
+endif()
+
+# Define common include directories
+set(COMMON_INCLUDE_DIRS ${EXECUTORCH_ROOT}/..)
+
+# Include utility CMake scripts from ExecuteTorch
+include(${EXECUTORCH_ROOT}/build/Utils.cmake)
+
+# Set OpenVINO directory from environment variable
+set(OPENVINO_DIR "$ENV{INTEL_OPENVINO_DIR}")
+if(NOT OPENVINO_DIR)
+    message(FATAL_ERROR "ERROR: INTEL_OPENVINO_DIR environment variable is not set.")
+endif()
+
+# Set OpenVINO include directories
+set(OPENVINO_INCLUDE_DIRS
+    ${OPENVINO_DIR}/runtime/include
+    ${OPENVINO_DIR}/deployment_tools/inference_engine/include
+)
+
+# Set OpenVINO library path
+set(OPENVINO_LIB_PATH ${OPENVINO_DIR}/runtime/lib/intel64)
+
+# Try to locate OpenVINO automatically
+find_library(OPENVINO_LIB NAMES openvino PATHS ${OPENVINO_LIB_PATH} NO_DEFAULT_PATH)
+if(NOT OPENVINO_LIB)
+    message(FATAL_ERROR "ERROR: OpenVINO library (libopenvino.so) not found in ${OPENVINO_LIB_PATH}")
+endif()
+
+# Define OpenVINO backend as a shared library
+add_library(openvino_backend SHARED)
+
+# Enable exceptions and RTTI for OpenVINO backend
+target_compile_options(openvino_backend PRIVATE -frtti -fexceptions)
+
+# Include ExecuteTorch and OpenVINO directories
+target_include_directories(openvino_backend PUBLIC ${COMMON_INCLUDE_DIRS} ${OPENVINO_INCLUDE_DIRS})
+
+# Link OpenVINO and ExecuteTorch core libraries
+target_link_libraries(openvino_backend PRIVATE ${OPENVINO_LIB} executorch_core)
+
+# Add source files for OpenVINO backend
+target_sources(openvino_backend PRIVATE ${CMAKE_CURRENT_LIST_DIR}/runtime/OpenvinoBackend.cpp)
+
+# Set runtime library path for OpenVINO
+target_link_options(openvino_backend PRIVATE -Wl,-rpath=${OPENVINO_LIB_PATH})
+
+# Install OpenVINO backend library to the lib directory
+install(TARGETS openvino_backend DESTINATION lib)
+

backends/openvino/README.md

@@ -0,0 +1,90 @@
+# OpenVINO Backend for ExecuTorch
+The OpenVINO backend enables optimized execution of deep learning models on Intel hardware, leveraging Intel's [OpenVINO toolkit](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/overview.html) for inference acceleration.
+
+## Supported Hardware
+
+OpenVINO backend supports the following hardware:
+
+- Intel CPUs
+- Intel integrated GPUs
+- Intel discrete GPUs
+- Intel NPUs
+
+## Directory Structure
+
+```
+executorch
+├── backends
+│   └── openvino
+│       ├── runtime
+│           ├── OpenvinoBackend.cpp
+│           └── OpenvinoBackend.hpp
+│       ├── scripts
+│           └── openvino_build.sh
+│       ├── tests
+│       ├── CMakeLists.txt
+│       ├── README.md
+│       ├── __init__.py
+│       ├── openvino_functions.yaml
+│       ├── partitioner.py
+│       ├── preprocess.py
+│       └── requirements.txt
+└── examples
+│   └── openvino
+│       ├── aot
+│           ├── README.md
+│           └── aot_openvino_compiler.py
+│       └── executor_runner
+│           └── openvino_executor_runner.cpp
+│       ├── CMakeLists.txt
+│       ├── README.md
+└──     └── openvino_build_example.sh
+```
+
+## Build Instructions
+
+### Prerequisites
+
+Before you begin, ensure you have openvino installed and configured on your system:
+
+## TODO: Update with the openvino commit/Release tag once the changes in OpenVINO are merged
+## TODO: Add instructions for support with OpenVINO release package
+
+```bash
+git clone -b executorch_ov_backend https://github.com/ynimmaga/openvino
+cd openvino
+git submodule update --init --recursive
+mkdir build
+cd build
+cmake .. -DCMAKE_BUILD_TYPE=Release -DENABLE_PYTHON=ON
+make -j<N>
+
+cd ..
+cmake --install build --prefix <your_preferred_install_location>
+cd <your_preferred_install_location>
+source setupvars.sh
+```
+
+### Setup
+
+Follow the steps below to setup your build environment:
+
+1. **Setup ExecuTorch Environment**: Refer to the [Environment Setup](https://pytorch.org/executorch/stable/getting-started-setup#environment-setup) guide for detailed instructions on setting up the ExecuTorch environment.
+
+2. **Setup OpenVINO Backend Environment**
+- Install the dependent libs. Ensure that you are inside `executorch/backends/openvino/` directory
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+3. Navigate to `scripts/` directory.
+
+4. **Build OpenVINO Backend**: Once the prerequisites are in place, run the `openvino_build.sh` script to start the build process, OpenVINO backend will be built under `cmake-openvino-out/backends/openvino/` as `libopenvino_backend.so`
+
+   ```bash
+   ./openvino_build.sh
+   ```
+
+### Run
+
+Please refer to [README.md](../../examples/openvino/README.md) for instructions on running examples of various of models with openvino backend.

backends/openvino/__init__.py

@@ -0,0 +1,5 @@
+from .partitioner import OpenvinoPartitioner
+from .preprocess import OpenvinoBackend
+from .quantizer.quantizer import OpenVINOQuantizer
+
+__all__ = [OpenvinoBackend, OpenvinoPartitioner, OpenVINOQuantizer]