Merge pull request #5 from neuralize-ai/1-add-tflite-support

1 add tflite support

Author: ciaranbor

.clang-tidy

@@ -71,15 +71,15 @@ CheckOptions:
   - key: 'readability-identifier-naming.ConstexprVariableCase'
     value: 'camelBack'
   - key: 'readability-identifier-naming.EnumCase'
-    value: 'camelBack'
+    value: 'CamelCase'
   - key: 'readability-identifier-naming.EnumConstantCase'
-    value: 'camelBack'
+    value: 'CamelCase'
   - key: 'readability-identifier-naming.FunctionCase'
     value: 'camelBack'
   - key: 'readability-identifier-naming.GlobalConstantCase'
-    value: 'camelBack'
+    value: 'CamelCase'
   - key: 'readability-identifier-naming.GlobalConstantPointerCase'
-    value: 'camelBack'
+    value: 'CamelCase'
   - key: 'readability-identifier-naming.GlobalFunctionCase'
     value: 'camelBack'
   - key: 'readability-identifier-naming.GlobalPointerCase'
@@ -127,7 +127,7 @@ CheckOptions:
   - key: 'readability-identifier-naming.PublicMethodCase'
     value: 'camelBack'
   - key: 'readability-identifier-naming.ScopedEnumConstantCase'
-    value: 'camelBack'
+    value: 'CamelCase'
   - key: 'readability-identifier-naming.StaticConstantCase'
     value: 'camelBack'
   - key: 'readability-identifier-naming.StaticVariableCase'

.codespellrc

@@ -4,3 +4,4 @@ check-filenames =
 check-hidden =
 skip = */.git,*/build,*/prefix,*/conan
 quiet-level = 2
+ignore-words-list=lite

.gitattributes

@@ -0,0 +1 @@
+*.tflite filter=lfs diff=lfs merge=lfs -text

.github/workflows/ci.yml

@@ -3,11 +3,11 @@ name: Continuous Integration
 on:
   push:
     branches:
-    - master
+    - main
 
   pull_request:
     branches:
-    - master
+    - main
 
 jobs:
   lint:
@@ -43,6 +43,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        lfs: true
 
     - name: Install LCov
       run: sudo apt-get update -q
@@ -69,7 +71,7 @@ jobs:
 
     - name: Test
       working-directory: build/coverage
-      run: ctest --output-on-failure --no-tests=error -j 2
+      run: ctest --output-on-failure --no-tests=error -j 2 -R "CPU"
 
     - name: Process coverage info
       run: cmake --build build/coverage -t coverage
@@ -87,8 +89,12 @@ jobs:
 
     env: { CXX: clang++-14 }
 
+    if: false
+
     steps:
     - uses: actions/checkout@v4
+      with:
+        lfs: true
 
     - name: Install Python
       uses: actions/setup-python@v5
@@ -120,14 +126,14 @@ jobs:
           halt_on_error=1"
         UBSAN_OPTIONS: "print_stacktrace=1:\
           halt_on_error=1"
-      run: ctest --output-on-failure --no-tests=error -j 2
+      run: ctest --output-on-failure --no-tests=error -j 2 -R "CPU"
 
   test:
     needs: [lint]
 
     strategy:
       matrix:
-        os: [macos-14, ubuntu-22.04, windows-2022]
+        os: [macos-14, ubuntu-22.04] #, windows-2022]
 
         type: [shared, static]
 
@@ -139,6 +145,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+      with:
+        lfs: true
 
     - name: Install static analyzers
       if: matrix.os == 'ubuntu-22.04'
@@ -184,9 +192,14 @@ jobs:
     - name: Install
       run: cmake --install build --config Release --prefix prefix
 
+    - name: Check
+      run: |
+        ls models/tflite
+        ls build/test/models/tflite
+
     - name: Test
       working-directory: build
-      run: ctest --output-on-failure --no-tests=error -C Release -j 2
+      run: ctest --output-on-failure --no-tests=error -C Release -j 2 -R "CPU"
 
   docs:
     # Deploy docs only when builds succeed

CMakeLists.txt

@@ -17,7 +17,8 @@ include(cmake/variables.cmake)
 
 add_library(
     edgerunner_edgerunner
-    source/edgerunner.cpp
+    source/tflite/model.cpp
+    source/tflite/tensor.cpp
 )
 add_library(edgerunner::edgerunner ALIAS edgerunner_edgerunner)
 
@@ -30,7 +31,11 @@ generate_export_header(
 )
 
 if(NOT BUILD_SHARED_LIBS)
-  target_compile_definitions(edgerunner_edgerunner PUBLIC EDGERUNNER_STATIC_DEFINE)
+    target_compile_definitions(
+        edgerunner_edgerunner
+        PUBLIC
+        EDGERUNNER_STATIC_DEFINE
+    )
 endif()
 
 set_target_properties(
@@ -60,18 +65,32 @@ target_compile_features(edgerunner_edgerunner PUBLIC cxx_std_17)
 find_package(fmt REQUIRED)
 target_link_libraries(edgerunner_edgerunner PRIVATE fmt::fmt)
 
+find_package(span-lite REQUIRED)
+target_link_libraries(edgerunner_edgerunner PUBLIC nonstd::span-lite)
+
+find_package(tensorflowlite REQUIRED)
+target_link_libraries(edgerunner_edgerunner PUBLIC tensorflow::tensorflowlite)
+
+if(edgerunner_ENABLE_GPU)
+    target_compile_definitions(
+        edgerunner_edgerunner
+        PUBLIC
+        EDGERUNNER_GPU
+    )
+endif()
+
 # ---- Install rules ----
 
 if(NOT CMAKE_SKIP_INSTALL_RULES)
-  include(cmake/install-rules.cmake)
+    include(cmake/install-rules.cmake)
 endif()
 
 # ---- Developer mode ----
 
 if(NOT edgerunner_DEVELOPER_MODE)
-  return()
+    return()
 elseif(NOT PROJECT_IS_TOP_LEVEL)
-  message(
+    message(
       AUTHOR_WARNING
       "Developer mode is intended for developers of edgerunner"
   )

README.md

@@ -1,16 +1,16 @@
-# edgerunner
+# Edgerunner
 
-This is the edgerunner project.
+Edgerunner is a cross-platform, cross-runtime ML inference library for mobile devices. The motivation for Edgerunner is to facilitate quick and easy integration of arbitrary ML models that are targeted for consumer mobile devices (smartphones, laptops, wearables, etc). This is achieved through a convenient runtime-agnostic API.
 
-# Building and installing
+## Building and installing
 
 See the [BUILDING](BUILDING.md) document.
 
-# Contributing
+## Contributing
 
 See the [CONTRIBUTING](CONTRIBUTING.md) document.
 
-# Licensing
+## Licensing
 
 <!--
 Please go to https://choosealicense.com/licenses/ and choose a license that

cmake/install-config.cmake

@@ -1,4 +1,6 @@
 include(CMakeFindDependencyMacro)
 find_dependency(fmt)
+find_dependency(span-lite)
+find_dependency(tensorflowlite)
 
 include("${CMAKE_CURRENT_LIST_DIR}/edgerunnerTargets.cmake")

cmake/variables.cmake

@@ -5,8 +5,8 @@
 # Targets necessary to build the project must be provided unconditionally, so
 # consumers can trivially build and package the project
 if(PROJECT_IS_TOP_LEVEL)
-  option(edgerunner_DEVELOPER_MODE "Enable developer mode" OFF)
-  option(BUILD_SHARED_LIBS "Build shared libs." OFF)
+    option(edgerunner_DEVELOPER_MODE "Enable developer mode" OFF)
+    option(BUILD_SHARED_LIBS "Build shared libs." OFF)
 endif()
 
 # ---- Suppress C4251 on Windows ----
@@ -29,13 +29,15 @@ set(pragma_suppress_c4251 "
 # add_subdirectory or FetchContent is used to consume this project
 set(warning_guard "")
 if(NOT PROJECT_IS_TOP_LEVEL)
-  option(
+    option(
       edgerunner_INCLUDES_WITH_SYSTEM
       "Use SYSTEM modifier for edgerunner's includes, disabling warnings"
       ON
   )
-  mark_as_advanced(edgerunner_INCLUDES_WITH_SYSTEM)
-  if(edgerunner_INCLUDES_WITH_SYSTEM)
-    set(warning_guard SYSTEM)
-  endif()
+    mark_as_advanced(edgerunner_INCLUDES_WITH_SYSTEM)
+    if(edgerunner_INCLUDES_WITH_SYSTEM)
+        set(warning_guard SYSTEM)
+    endif()
 endif()
+
+option(edgerunner_ENABLE_GPU "Enable GPU support" OFF)

conanfile.py

@@ -10,6 +10,8 @@ def layout(self):
 
     def requirements(self):
         self.requires("fmt/10.2.1")
+        self.requires("span-lite/0.11.0", transitive_headers=True)
+        self.requires("tensorflow-lite/2.12.0")
 
     def build_requirements(self):
         self.test_requires("catch2/3.6.0")

include/edgerunner/edgerunner.hpp renamed to include/edgerunner/model.hpp

@@ -2,9 +2,11 @@
 
 #include <filesystem>
 #include <string>
-#include <vector>
+
+#include <nonstd/span.hpp>
 
 #include "edgerunner/edgerunner_export.hpp"
+#include "tensor.hpp"
 
 namespace edge {
 
@@ -50,17 +52,24 @@ namespace edge {
  * they also solve some other problems that make them worth the time invested.
  */
 
+enum class DELEGATE {
+    CPU,
+    GPU,
+    NPU,
+};
+
+enum class STATUS {
+    SUCCESS,
+    FAIL
+};
+
 /**
  * @brief Reports the name of the library
  *
  * Please see the note above for considerations when creating shared libraries.
  */
-template<typename Tensor>
 class EDGERUNNER_EXPORT Model {
   public:
-    /**
-     * @brief Initializes the name field to the name of the project
-     */
     Model() = default;
 
     Model(const Model&) = default;
@@ -76,21 +85,43 @@ class EDGERUNNER_EXPORT Model {
 
     auto getNumOutputs() const -> size_t { return m_outputs.size(); }
 
-    auto getInput(size_t index) const -> Tensor&;
+    auto getInput(size_t index) const -> std::shared_ptr<Tensor> {
+        if (index < getNumInputs()) {
+            return m_inputs[index];
+        }
 
-    auto getOutput(size_t index) const -> Tensor&;
+        return {};
+    }
 
-    virtual void execute() = 0;
+    auto getOutput(size_t index) const -> std::shared_ptr<Tensor> {
+        if (index < getNumOutputs()) {
+            return m_outputs[index];
+        }
+
+        return {};
+    }
+
+    void setDelegate(const DELEGATE& delegate) { m_delegate = delegate; }
+
+    auto getDelegate() const -> DELEGATE { return m_delegate; }
+
+    virtual auto applyDelegate() -> STATUS = 0;
+
+    virtual auto execute() -> STATUS = 0;
 
     /**
      * @brief Returns a non-owning pointer to the string stored in this class
      */
     auto name() const -> char const* { return m_name.c_str(); }
 
   protected:
-    auto accessInputs() -> std::vector<Tensor>& { return m_inputs; }
+    auto accessInputs() -> std::vector<std::shared_ptr<Tensor>>& {
+        return m_inputs;
+    }
 
-    auto accessOutputs() -> std::vector<Tensor>& { return m_outputs; }
+    auto accessOutputs() -> std::vector<std::shared_ptr<Tensor>>& {
+        return m_outputs;
+    }
 
     void setName(const std::string& name) { m_name = name; }
 
@@ -99,10 +130,13 @@ class EDGERUNNER_EXPORT Model {
     std::string m_name;
 
     EDGERUNNER_SUPPRESS_C4251
-    std::vector<Tensor> m_inputs;
+    std::vector<std::shared_ptr<Tensor>> m_inputs;
+
+    EDGERUNNER_SUPPRESS_C4251
+    std::vector<std::shared_ptr<Tensor>> m_outputs;
 
     EDGERUNNER_SUPPRESS_C4251
-    std::vector<Tensor> m_outputs;
+    DELEGATE m_delegate = DELEGATE::CPU;
 };
 
 }  // namespace edge