Merge pull request #9 from analogdevicesinc/release-3.0.0

Release 3.0.0

Author: pagarwa3

.gitattributes

@@ -0,0 +1,12 @@
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.tfrecord filter=lfs diff=lfs merge=lfs -text
+*.pdom filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.h5.[[:space:]]*.wav filter=lfs diff=lfs merge=lfs -text
+*.doc filter=lfs diff=lfs merge=lfs -text
+*.xlsx filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text

.github/workflows/build-and-test.yml

@@ -6,16 +6,17 @@ on:
   push:
   pull_request:
     branches:
+      - 'release/**'
       - main
-      - dev
 
 jobs:
   Build-and-Test:
-    runs-on: self-hosted
+    runs-on: [self-hosted, tflm-runner]
     strategy:
       fail-fast: false
       matrix:
         cces_ver: ["3.0.0", "3.0.2"]
+        config: ["Release", "Debug"]
     container: 
         image: tagoylo/tflm-ci:latest
         volumes: 
@@ -24,48 +25,68 @@ jobs:
       CCES_PATH: /opt/analog/cces/${{ matrix.cces_ver }}
     steps:
         - uses: actions/checkout@v4
-        - name: Build libTFLM using CCES ${{ matrix.cces_ver }}
-          shell: bash
-          run: 
-            make -j4 SHARCFX_ROOT=${{ env.CCES_PATH }}
+          with:
+            submodules: recursive
+            token: ${{ secrets.GH_PAT }}
 
         - name: Build libadi_sharcfx_nn using CCES ${{ matrix.cces_ver }}
           shell: bash
           run: |
             cd adi_sharcfx_nn/Project
-            make -j4 SHARCFX_ROOT=${{ env.CCES_PATH }}
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
+
+        - name: Build libTFLM using CCES ${{ matrix.cces_ver }}
+          shell: bash
+          run: 
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
 
         - name: Build denoiser example project
           shell: bash
           run: |
-            cd Utils/automated-model-conversion/dtln
-            bash convert_models.sh
-            cd ../../../examples/denoiser/denoiser_fileio
-            make -j4 SHARCFX_ROOT=${{ env.CCES_PATH }}
+            cd cces/Utils/automated-model-conversion/dtln
+            chmod +x run_in_bash.sh
+            bash run_in_bash.sh
+            cd ../../../..
+            cd cces/examples/denoiser/denoiser_fileio
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
             cd ../denoiser_realtime
-            make -j4 SHARCFX_ROOT=${{ env.CCES_PATH }}
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
 
         - name: Build kws example project
           shell: bash
           run: |
-            cd examples/keyword_spotter/kws_fileio
-            make -j4 SHARCFX_ROOT=${{ env.CCES_PATH }}
+            cd cces/examples/keyword_spotter/kws_fileio
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
             cd ../kws_realtime
-            make -j4 SHARCFX_ROOT=${{ env.CCES_PATH }}
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
 
         - name: Build genre_id example project
           shell: bash
           run: |
-            cd Utils/automated-model-conversion/genre_identification
-            bash convert_models.sh
-            cd ../../../examples/genre_identification/genre_id_fileio
-            make -j4 SHARCFX_ROOT=${{ env.CCES_PATH }}
+            cd cces/examples/genre_identification/genre_id_fileio
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
+            cd ../genre_id_realtime
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
+
+        - name: Build urbansound_classification example project
+          shell: bash
+          run: |
+            cd cces/examples/urbansound_classification/urbansound_id_fileio
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
+            cd ../urbansound_id_realtime
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
 
+        - name: Build bootloader_sharcfx project
+          shell: bash
+          run: |
+            cd cces/Utils/flashing-tools/bootloader_sharcfx
+            make -j4 CONFIG=${{ matrix.config }} SHARCFX_ROOT=${{ env.CCES_PATH }}
+            
         - name: Test libTFLM artifact using CCES ${{ matrix.cces_ver }}
           shell: bash
           run: |
-            cd unit_test
-            make -j4 CCES=${{ env.CCES_PATH }} | tee test_results.log
+            cd test/unit_test
+            make -j4 CONFIG=${{ matrix.config }} CCES=${{ env.CCES_PATH }} | tee test_results.log
             if grep -q "FAILED" test_results.log; then
               echo "Unit test failed"
               exit 1
@@ -91,7 +112,7 @@ jobs:
             COMMIT_HASH=${GITHUB_SHA::7}
             UPLOAD_PATH="TFLM/${FOLDER_NAME}/build_${{ github.run_number }}-${BUILD_DATE}-${COMMIT_HASH}/${{ matrix.cces_ver }}"
             echo "Uploading test results to JF: ${{ env.JF_URL }}/$UPLOAD_PATH"
-            TEST_FILE_PATH="./unit_test/test_results.log"
+            TEST_FILE_PATH="./test/unit_test/test_results.log"
             curl -u${{ env.JF_ACCESS_TOKEN }} -T ${TEST_FILE_PATH} ${{ env.JF_URL }}/${UPLOAD_PATH}/ > /dev/null
             BUILD_FILE_PATH="./build/libTFLM.a"
             echo "Uploading build artifact to JF: ${{ env.JF_URL }}/$UPLOAD_PATH"

.gitignore

@@ -3,4 +3,33 @@ env
 .venv
 .env
 build
-tmp
+tmp
+# Ignore Git internal folder (redundant; Git never tracks this, but for clarity)
+.git/
+
+# Ignore metadata
+.metadata/
+
+# Ignore *.ignore files and folders
+*.ignore
+*.ignore/
+
+# Ignore all build-related folders
+**/build/
+**/Build/
+**/BUILD/
+
+# Ignore Debug and Release folders (case-insensitive)
+**/Debug/
+**/debug/
+**/Release/
+**/release/
+
+# Ignore temporary folders
+tmp/
+
+# Allow Debug and Release folders in specific paths
+!Lib/Debug/
+!Lib/Release/
+!cces/TFLM/lib/Debug/
+!cces/TFLM/lib/Release/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "adi_sharcfx_nn"]
+	path = adi_sharcfx_nn
+	url = https://github.com/analogdevicesinc/nn.git

Documents/ADI_TFLITE_MICRO_SHARCFX_Library_Product_Reference_Guide.pdf

@@ -1,8 +1,9 @@
 include ./tools/sharcfx/sharcfx.mk
 
 BUILD_DIR := ./build
-LIB_SRCS := ./TFLM/src
+LIB_SRCS := .
 LIB := libTFLM.a
+TARGET_LIB_DIR := $(LIB_SRCS)/cces/TFLM/Lib
 
 INCLUDES += \
 	-I"$(LIB_SRCS)" \
@@ -17,15 +18,15 @@ INCLUDES += \
 	-I"$(LIB_SRCS)/third_party/ruy/ruy/profiler" \
 	-I"$(LIB_SRCS)/third_party/ruy" \
 	-I"$(LIB_SRCS)/third_party/gemmlowp/fixedpoint"  \
-	-I"./examples/shared" \
+	-I"./cces/examples/shared" \
 	-I"./adi_sharcfx_nn/Include"
 
 C_SRCS += \
 	$(wildcard $(LIB_SRCS)/third_party/kissfft/tools/*.c) \
 	$(wildcard $(LIB_SRCS)/third_party/kissfft/*.c) \
 	$(wildcard $(LIB_SRCS)/tensorflow/lite/experimental/microfrontend/lib/*.c) \
 	$(wildcard $(LIB_SRCS)/tensorflow/lite/kernels/internal/optimized/*.c) \
-	$(wildcard ./examples/shared/*.c)
+	$(wildcard ./cces/examples/shared/*.c)
 
 CC_SRCS += \
 	$(wildcard $(LIB_SRCS)/tensorflow/lite/schema/*.cc) \

Documents/ADI_TFLITE_MICRO_SHARCFX_Product_Specification_guide.pdf

@@ -96,14 +96,15 @@ Next, build the `libTFLM.a` file:
 At this point, you should have a `libTFLM.a` library archive located inside the `Debug` or `Release` folder.
 
 Instructions to build and run the examples are found in their respective READMEs.
-- [Denoiser](examples/denoiser/README.md)
-- [Keyword Spotting](examples/keyword_spotter/README.md)
-- [Genre Identification](examples/genre_identification/README.md)
+- [Denoiser](cces/examples/denoiser/README.md)
+- [Keyword Spotting](cces/examples/keyword_spotter/README.md)
+- [Genre Identification](cces/examples/genre_identification/README.md)
+- [Urban Sound Classification](cces/examples/urbansound_classification/README.md)
 
-We have also included utilities for automated model conversion and flashing. These are available in the [utils](Utils) directory. 
-- [Automated model conversion for DTLN](Utils/automated-model-conversion/dtln/README.md)
-- [Automated model conversion for Genre ID](Utils/automated-model-conversion/genre_identification/README.md)
-- [Flashing](Utils/flashing-tools/README.md)
+We have also included utilities for automated model conversion and flashing. These are available in the [Utils](cces/Utils) directory. 
+- [Automated model conversion for DTLN](cces/Utils/automated-model-conversion/dtln/README.md)
+- [Automated model conversion for Genre ID](cces/Utils/automated-model-conversion/genre_identification/README.md)
+- [Flashing](cces/Utils/flashing-tools/README.md)
 
 ### Option 2: via the Headless build 
 
@@ -144,6 +145,17 @@ The default debugger is ICE-1000. To configure this with other debugger like the
 make flash DEBUGGER=2000
 ```
 
+### Multi-boot
+Please follow [bootloader_sharcfx](cces/Utils/flashing-tools/bootloader_sharcfx) for multi-stage booting functionality.
+
+Please note that the models we use in the example applications are for DEMO purpose only. If a product needs to be created using the same models, commercial license needs to be taken, and the necessary due diligence needs to be handled by the party with the rightful owners.
+
+## Datasets
+CC BY 4.0 compliant datasets for Urban Sound Classification and Music Genre Identification are available upon request for evaluation and training.
+
+APPENDIX A - THIRD PARTY LICENSES FOR OPEN-SOURCE COMPONENTS ARE DETAILED AT THE LOCATION BELOW:
+ * HTTPS://DOWNLOAD.ANALOG.COM/SHARC-FX-TFLM-EDGE-AI-SDK/VERSIONS.HTML [https://download.analog.com/sharc-fx-tflm-edge-ai-sdk/versions.html]
+
 # Getting Help
 
 Please raise a GitHub Issue for support.