Source code for mlonmcu.flow.tflm.framework

#
# Copyright (c) 2022 TUM Department of Electrical and Computer Engineering.
#
# This file is part of MLonMCU.
# See https://github.com/tum-ei-eda/mlonmcu.git for further info.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Definitions for TFLMFramework."""

from pathlib import Path

from mlonmcu.flow.framework import Framework
from mlonmcu.flow.tflm import TFLMBackend




class TFLMFramework(Framework):
    """TFLM Framework specialization."""

    name = "tflm"

    FEATURES = {"muriscvnn", "cmsisnn"}

    DEFAULTS = {
        "optimized_kernel": None,
        "optimized_kernel_inc_dirs": [],
        "optimized_kernel_libs": [],
    }

    REQUIRED = {"tf.src_dir"}

    backends = TFLMBackend.registry

    def __init__(self, features=None, config=None):
        super().__init__(features=features, config=config)

    @property
    def tf_src(self):
        return Path(self.config["tf.src_dir"])

    @property
    def optimized_kernel(self):
        return self.config["optimized_kernel"]

    @property
    def optimized_kernel_libs(self):
        return self.config["optimized_kernel_libs"]

    @property
    def optimized_kernel_inc_dirs(self):
        return self.config["optimized_kernel_inc_dirs"]



    def get_platform_defs(self, platform):
        ret = super().get_platform_defs(platform)
        if self.optimized_kernel or self.optimized_kernel_inc_dirs or self.optimized_kernel_libs:
            if self.optimized_kernel:
                ret["TFLM_OPTIMIZED_KERNEL"] = self.optimized_kernel
            if self.optimized_kernel_inc_dirs:
                if isinstance(self.optimized_kernel_inc_dirs, list):
                    temp = r"\;".join(self.optimized_kernel_inc_dirs)
                else:
                    temp = self.optimized_kernel_inc_dirs
                ret["TFLM_OPTIMIZED_KERNEL_INCLUDE_DIR"] = temp
            if self.optimized_kernel_libs:
                if isinstance(self.optimized_kernel_libs, list):
                    temp = r"\;".join(self.optimized_kernel_libs)
                else:
                    temp = self.optimized_kernel_libs
                ret["TFLM_OPTIMIZED_KERNEL_LIB"] = temp
        ret["TF_DIR"] = str(self.tf_src)
        return ret