diff --git a/.github/workflows/commit.yml b/.github/workflows/commit.yml new file mode 100644 index 0000000..e6a87f0 --- /dev/null +++ b/.github/workflows/commit.yml @@ -0,0 +1,35 @@ +name: '๐Ÿ“œ Check Commit Messages' + +on: + pull_request: + types: + - opened + - edited + - reopened + - synchronize + branches: + - 'master' + +jobs: + check-commit-messages: + runs-on: ubuntu-latest + steps: + - name: '๐Ÿ“œ Check commit messages format' + uses: gsactions/commit-message-checker@v2 + with: + pattern: '^[A-Za-z]+.+ .+\.$' + flags: 'gm' + error: 'Commit subject line must match the following pattern: ' + excludeTitle: 'false' + excludeDescription: 'true' + checkAllCommitMessages: 'true' + accessToken: ${{ secrets.GITHUB_TOKEN }} + - name: '๐Ÿ“œ Check commit messages length' + uses: gsactions/commit-message-checker@v2 + with: + pattern: '^[^#].{10,78}$' + error: 'Commit subject line maximum line length of 78 characters is exceeded.' + excludeTitle: 'false' + excludeDescription: 'true' + checkAllCommitMessages: 'true' + accessToken: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/tflm.yml b/.github/workflows/tflm.yml new file mode 100644 index 0000000..014df3c --- /dev/null +++ b/.github/workflows/tflm.yml @@ -0,0 +1,154 @@ +name: '๐Ÿ”ฅ Build TFLM' + +on: + push: + tags: + - 'v*.*.*' + branches: + - 'main' + paths: + - 'src/**' + - '.github/workflows/*.yml' + - '.github/workflows/*.json' + - '!**/README.md' + - '!**.rst' + + pull_request: + branches: + - 'main' + paths: + - 'src/**' + - '.github/workflows/*.yml' + - '.github/workflows/*.json' + - '!**/README.md' + - '!**.rst' + +jobs: + build-tflm: + runs-on: ubuntu-20.04 + + strategy: + matrix: + target: [cortex-m0plus, cortex-m4+fp, cortex-m7+fp, cortex-m55] + build: [release, debug] + fail-fast: false + + steps: + - name: 'โณ Checkout main' + uses: actions/checkout@v4 + with: + submodules: false + + - name: 'โณ Checkout TFLM' + uses: actions/checkout@v4 + with: + submodules: false + path: tflite-micro + repository: tensorflow/tflite-micro + ref: 8c458fc48ee972ea4fc56ddc08849823b9af7ea8 + + - name: 'โ™ป Caching dependencies' + uses: actions/cache@v4.0.2 + id: cache + with: + path: ~/cache/gcc + key: 'arm-gnu-toolchain-13.2.rel1' + + - name: '๐Ÿ›  Install toolchain ' + if: steps.cache.outputs.cache-hit != 'true' + run: source tools/ci.sh && ci_install_arm_gcc + + - name: '๐Ÿ›  Install dependencies' + run: | + python -m pip install --upgrade pip numpy==1.24 Pillow==10.3 + + - name: '๐Ÿ— Build TFLM' + run: source tools/ci.sh && ci_build_target ${{ matrix.target }} ${{ matrix.build }} + + - name: 'โฌ† Upload libraries' + uses: actions/upload-artifact@v4 + with: + name: ${{ matrix.target }} + path: ${{ matrix.target }} + if-no-files-found: error + + build-tflm-headers: + runs-on: ubuntu-20.04 + + steps: + - name: 'โณ Checkout main' + uses: actions/checkout@v4 + with: + submodules: false + + - name: 'โณ Checkout TFLM' + uses: actions/checkout@v4 + with: + submodules: false + path: tflite-micro + repository: tensorflow/tflite-micro + ref: 8c458fc48ee972ea4fc56ddc08849823b9af7ea8 + + - name: 'โ™ป Caching dependencies' + uses: actions/cache@v4.0.2 + id: cache + with: + path: ~/cache/gcc + key: 'arm-gnu-toolchain-13.2.rel1' + + - name: '๐Ÿ›  Install toolchain ' + if: steps.cache.outputs.cache-hit != 'true' + run: source tools/ci.sh && ci_install_arm_gcc + + - name: '๐Ÿ›  Install dependencies' + run: | + python -m pip install --upgrade pip numpy==1.24 Pillow==10.3 + + - name: '๐Ÿ— Build headers' + run: source tools/ci.sh && ci_build_headers include + + - name: 'โฌ† Upload headers' + uses: actions/upload-artifact@v4 + with: + name: include + path: include + if-no-files-found: error + + push-artifacts: + runs-on: ubuntu-20.04 + needs: [build-tflm, build-tflm-headers] +# if: github.event_name == 'push' + permissions: + contents: write + pull-requests: write + + steps: + - name: 'โณ Checkout repository' + uses: actions/checkout@v4 + with: + submodules: false + + - name: '๐Ÿงน Remove old headers ' + run: | + rm -fr include + + - name: 'โฌ‡ Download artifacts' + uses: actions/download-artifact@v4 + + - name: Create Pull Request + uses: peter-evans/create-pull-request@v5 + with: + base: main + branch: update_tflm + title: Update tflm libraries and headers. + commit-message: Update tflm libraries and headers. + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: '๐Ÿงน Remove artifacts' + uses: geekyeggo/delete-artifact@v5 + with: + name: | + cortex* + include + failOnError: false diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - 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. diff --git a/tools/ci.sh b/tools/ci.sh new file mode 100644 index 0000000..7a42ed5 --- /dev/null +++ b/tools/ci.sh @@ -0,0 +1,80 @@ +#!/bin/bash +# This file is part of the OpenMV project. +# +# Copyright (c) 2024 Ibrahim Abdelkader +# Copyright (c) 2024 Kwabena W. Agyeman +# +# This work is licensed under the MIT license, see the file LICENSE for details. + +# Install ARM GCC. +######################################################################################## +TFLM_REPO_PATH=tflite-micro +TOOLCHAIN_PATH=${HOME}/cache/gcc +export PATH=${TOOLCHAIN_PATH}/bin:${PATH} +TOOLCHAIN_URL="https://developer.arm.com/-/media/Files/downloads/gnu/13.2.rel1/binrel/arm-gnu-toolchain-13.2.rel1-x86_64-arm-none-eabi.tar.xz" + +ci_install_arm_gcc() { + mkdir -p ${TOOLCHAIN_PATH} + wget --no-check-certificate -O - ${TOOLCHAIN_URL} | tar --strip-components=1 -Jx -C ${TOOLCHAIN_PATH} + export PATH=${TOOLCHAIN_PATH}/bin:${PATH} + arm-none-eabi-gcc --version +} + +# Update Submodules. +######################################################################################## +ci_update_submodules() { + git submodule update --init --depth=1 --no-single-branch +} + +# Build Targets. +######################################################################################## +ci_build_target() { + BUILD_TARGET=${1} + BUILD_TYPE=${2} + mkdir -p ${BUILD_TARGET} + pushd ${TFLM_REPO_PATH} + make -j$(nproc) -f tensorflow/lite/micro/tools/make/Makefile \ + TARGET=cortex_m_generic TARGET_ARCH=${BUILD_TARGET} OPTIMIZED_KERNEL_DIR=cmsis_nn \ + TARGET_TOOLCHAIN_ROOT=${TOOLCHAIN_PATH}/bin/ TARGET_TOOLCHAIN_PREFIX=arm-none-eabi- \ + BUILD_TYPE=${BUILD_TYPE} CORE_OPTIMIZATION_LEVEL=-O2 MICROLITE_LIB_NAME=libtflm.a microlite + popd + if [ ${BUILD_TYPE} = "debug" ]; then + LIB_NAME="libtflm_debug.a" + else + LIB_NAME="libtflm.a" + fi + mv ${TFLM_REPO_PATH}/gen/*/lib/libtflm.a ${BUILD_TARGET}/${LIB_NAME} +} + +# Build Headers. +######################################################################################## +ci_build_headers() { + HEADERS_PATH="${1}" + mkdir -p ${HEADERS_PATH} + pushd ${TFLM_REPO_PATH} + python3 tensorflow/lite/micro/tools/project_generation/create_tflm_tree.py --makefile_options="TARGET=cortex_m_generic TARGET_ARCH=cortex-m7+fp OPTIMIZED_KERNEL_DIR=cmsis_nn TARGET_TOOLCHAIN_ROOT=/opt/arm-none-eabi/bin/ TARGET_TOOLCHAIN_PREFIX=arm-none-eabi- BUILD_TYPE=release" headers + popd + cp -r ${TFLM_REPO_PATH}/headers/* ${HEADERS_PATH} + find ${HEADERS_PATH} -name "*.c" -type f -delete + find ${HEADERS_PATH} -name "*.cc" -type f -delete +} + +# Build Headers. +######################################################################################## +ci_build_headers_makefile() { + HEADERS_PATH="${1}" + mkdir -p ${HEADERS_PATH} + pushd ${TFLM_REPO_PATH} + headers=$(make -j$(nproc) -f tensorflow/lite/micro/tools/make/Makefile \ + TARGET=cortex_m_generic TARGET_ARCH=cortex-m7+fp OPTIMIZED_KERNEL_DIR=cmsis_nn \ + TARGET_TOOLCHAIN_ROOT=${TOOLCHAIN_PATH}/bin/ TARGET_TOOLCHAIN_PREFIX=arm-none-eabi- \ + BUILD_TYPE=release list_library_headers list_third_party_headers) + + popd + + readarray -d ' ' -t files <<< $headers + for file in ${files[@]}; do + mkdir -p ${HEADERS_PATH}/$(dirname ${file}) + cp ${TFLM_REPO_PATH}/${file} ${HEADERS_PATH}/${file} + done +}