Target of the V1.2.0

On the basis of v1.1.0, v1.2.0 mainly has the following updates：

The samples provided in the SDK release can provide some simple samples, such as a single model from creation, detection, and processing results.
Modify sample->demo, unitest->sample.
Two compilation methods, cmake and makefile, have been added to the new sample.
- Makefile supports compiling sample code using the snnf_build.sh script.
- Cmake supports compiling samples using the script snnf_build_sample.sh in the release directory.
- Makefile supports compiling individual samples separately in the release directory.
Organize the rotate function of OCRDet, provide an interface for the application layer to enable this function, and set the horizontal or vertical mode.
Since you can now select some model to use from the model zoo, the model list in snnf_demo is correspond to the current selection.
Whether it's compiling SNNF open source code or compiling SNNF release samples, there is a way for users to easily switch project config between official settings and customer settings.
- The configuration of makefile_config_user.mk is already supported. If this file exists in the project directory, the configuration of this file shall prevail. If this file is not available, use the configuration in the default (makefile_config.mk) file.
- In the two config files mentioned above, configuring the models of plugin or buildin can effectively control the release code size or bin size.
Both buildin and plugin models also need to add a configure option for configuration.
Adjust commands ./snnf_demo.sh -a， Make each test case have an independent delimiter and a specific test name, and ensure that every tested item can be tested. Ensure that every example of ./snnf_demo.sh is genuine and usable.
Generate 《Models' Guide》 for SNNF sample introduction.

Resource

Please get the V1.2.0 release resource here.

Before starting any work, please carefully read the instruction files such as readme.md in the document directory.

Usage of V1.2.0

How to verify Official Demos

You can use the script we provide to start as follows：

/SNNF/release # ./snnf_demo.sh
Usage: ./bin/snnf_demo [-m|-s|-a|-h] [-i|-v|-o|option]
        Version: 1.2.0_V1.2.0
        Time: 2025-01-24 14:35:55 +0800
        [-m,--model <model>] run a single model
                <model>:Age                        Det10g                     HumanAttr
                        LightFace                  OcrCls                     OcrDet
                        OcrRec                     VehicleAttr                W600kR50
                        YoloV8sOdMap               Yolov5sDetection           Yolov5sV1
                        Yolov8nClassify            Yolov8sClassify            stgcn
                        Yolov5sV2                  BotSortTrack               BotSortTrackStgcn
                        GenderAge                  Rtmdets                    YoloV10sDetection
                        YoloV8nCcpdOpti            YoloV8nDetectionBaseOpti   YoloV8nDetectionOpti
                        YoloV8nObbOpti             YoloV8nPoseOpti            YoloV8nSegmentOpti
                        YoloV8sDetection           YoloV8sDetectionBaseOpti   YoloV8sDetectionOpti
                        YoloV8sObb                 YoloV8sPose                YoloV8sSegment

                example:./bin/snnf_demo -m Yolov5sDetection
                        ./bin/snnf_demo --model HumanAttr

        [-s,--sequential <model1,model2,...>] run sequential models
                <models>:Yolov5sDetection,HumanFilter,HumanAttr
                        LightFace,Age
                        OcrDet,OcrRec
                        OcrDet,OcrCls,OcrRec
                        Det10g,W600kR50
                        YoloV8sDetection,VehicleFilter,VehicleAttr
                        YoloV8nDetectionOpti,BotSortTrack
                        YoloV8nPoseOpti,BotSortTrackStgcn
                        YoloV8nCcpdOpti,OcrRec
                        YoloV8nCcpdOpti,OcrCls,OcrRec
                example:./bin/snnf_demo -s Yolov5sDetection,HumanFilter,HumanAttr
                        ./bin/snnf_demo --sequential OcrDet,OcrCls,OcrRec
                        ./bin/snnf_demo -s YoloV8nCcpdOpti,OcrRec,imageWriter
                        ./bin/snnf_demo -s YoloV8sDetectionOpti,BotSortTrack,videoWriter -v resource/video/humanTracking.mp4
                        ./bin/snnf_demo -s YoloV8nPoseOpti,BotSortTrackStgcn,videoWriter -v resource/video/person-falling.mp4

        [-i,--image file] set image file to nn detection.
                <file>: file name
                [-c | option]: test count, this parameter is only match with -i
                example:./bin/snnf_demo -s Yolov5sDetection,HumanFilter,HumanAttr -i resource/image/person.jpg -c 2
                        ./bin/snnf_demo -s Yolov5sDetection,HumanFilter,HumanAttr --image resource/image/person.jpg -c 2

        [-v,--video file] set video file to nn detection.
                <file>: file name
                example:./bin/snnf_demo -s YoloV8sDetectionOpti,BotSortTrack,videoWriter -v resource/video/humanTracking.mp4
                        ./bin/snnf_demo -s YoloV8sDetectionOpti,BotSortTrack,videoWriter --video resource/video/humanTracking.mp4

        [-o,--output file] specify the output file name for saving results.
                <file>: file name with extension (e.g., output.jpg, output.json, output.mp4)
                This parameter must be used in conjunction with imageWriter, jsonWriter, or videoWriter.
                example:./bin/snnf_demo -s Yolov5sDetection,HumanFilter,HumanAttr,imageWriter -i resource/image/person.jpg -o output.jpg
                        ./bin/snnf_demo -s Yolov5sDetection,HumanFilter,HumanAttr,jsonWriter -i resource/image/person.jpg -o output.json
                        ./bin/snnf_demo -s YoloV8sDetectionOpti,BotSortTrack,videoWriter -v resource/video/humanTracking.mp4 -o output.mp4

        [-a,--all] run all model testing

        assist tools: imageWriter videoWriter jsonWriter BotSortTrack HumanFilter VehicleFilter

Release folder structure

bin: Some prebuild application.
- snnf_demo. Prebuild demo programs that can run on the c3v Linux platform. Just a demo showcasing the functionality of SNNF.
- snnf_sequential_model. Prebuild sample for sequantial flow. Customers can follow the sample code here to improve similar features they want.
- snnf_single_model. Prebuild sample for single model. Customers can follow the sample code here to improve similar features they want.
- snnf_tracking. Prebuild sample for human tracking or vehicle tracking. Customers can follow the sample code here to improve similar features they want.
- snnf_yolov8s_map. Prebuild sample for mAP test. Customers can follow the sample code here to improve similar features they want.
cmake：The cmake config both for build on C3V and cross compiling.
demo：The source code of snnf_demo.
include：header file of sunplus NN framework SDK.
lib：libraries of sunplus NN framework SDK.
model_config.mk：Model selection both for demo and sample.
resource
- config: some config files for features.
- font: ttf file for plotting sample.
- image: image files used for test.
- model: models to be used in the sample program.
- video: video files used for test.
samples：sample code for using sunplus NN framework.
snnf_build_demo.sh：executable script for building demo code.
snnf_build_samples.sh: executable script for building sample code.
snnf_demo.sh：executable script for running demo code.
snnf_env.sh: executable script for compiling environment.
thirdparty: just as its name implies.

How to run SNNF demo

Copy the release foler to C3V Linux.

/SNNF/release # ls -alh
total 480K
drwxr-xr-x 10 root root  32K Jan 23  2025 .
drwxr-xr-x  3 root root  32K Jan 23  2025 ..
drwxr-xr-x  2 root root  32K Jan 23  2025 bin
drwxr-xr-x  2 root root  32K Jan 23  2025 cmake
drwxr-xr-x  5 root root  32K Jan 23  2025 demo
drwxr-xr-x  6 root root  32K Jan 23  2025 include
drwxr-xr-x  3 root root  32K Jan 23  2025 lib
-rwxr-xr-x  1 root root  839 Jan 23  2025 model_config.mk
drwxr-xr-x  7 root root  32K Jan 23  2025 resource
drwxr-xr-x  6 root root  32K Jan 23  2025 samples
-rwxr-xr-x  1 root root  907 Jan 23  2025 snnf_build_demo.sh
-rwxr-xr-x  1 root root 1.1K Jan 23  2025 snnf_build_samples.sh
-rwxr-xr-x  1 root root  493 Jan 23  2025 snnf_demo.sh
-rwxr-xr-x  1 root root 1.7K Jan 23  2025 snnf_env.sh
drwxr-xr-x  9 root root  32K Jan 23  2025 thirdparty

Run nnf_run.sh to run the SNNF demo.

a. One-time input

./snnf_demo.sh -m YoloV8sDetection

# ./snnf_demo.sh -m YoloV8sDetection
1737541183779|7fa7539040|T|common: [app]YoloV8sDetection in
1737541185047|7f9504a080|T|common: [app]GeneralModelOutputListener detect from resource/image/vehicle.jpg, the result: (box: 415.31 288.56 1218.38 520.88) --> label: 2(car), confidence: 0.96, fin: true
1737541185097|7fa7539040|T|common: [app]YoloV8sDetection out, retVal: -0x0

b. Read input from the image file

./snnf_demo.sh -m YoloV8nDetectionOpti -i resource/image/person640x640.jpg

c. Read inputs from the video file.

./snnf_demo.sh -m YoloV8nDetectionOpti -v resource/video/humanCount.mp4

d. Sequential models

./snnf_demo.sh -s Yolov5sDetection,HumanAttr

e. Model inference results save to image.

./snnf_demo.sh -s YoloV8sPose,imageWriter

Results will save to the image detected_1883_0931_1737541806800.jpg.

f. Model inference results save to json file.

./snnf_demo.sh -s YoloV8sPose,jsonWriter -o yolov8PoseResults.json

Results will save to yolov8PoseResults.json. If the - o option is unused, it will be saved as a file by default: default_result.json.

How to build SNNF

Cross-compile for C3V environment.

a. Please use snnf_build.sh for SNNF compiling.

b. All the resource will be installed to the release folder.

Copy the release folder to the C3V platform.
Setup environment variable.

a. Setting environment variables independently.

b. Run snnf_demo.sh will auto set environment variables.

Then, you can run snnf_run.sh for SNNF demo.

SNNF Sample introduction

Please refer to 《Models' Guide》.

User API

Please refer to API DOC v2.0 .

C3V Documentation

V1.2.0 of SNNF

Analytics