SOPHONSDK User Guide

Catalogue

• 1. Declaration
• 2. Introduction
  • 2.1. Explanation of Terms
    • 2.1.1. Operating Modes
    • 2.1.2. Development and Runtime Environments
    • 2.1.3. Hardware Memory
    • 2.1.4. BModel
    • 2.1.5. bm_image
• 3. SDK Porting Development Overview and Packages
  • 3.1. Overview of SDK Migration and Development
    • 3.1.1. SDK Learning Path
    • 3.1.2. Algorithm Migration Process
    • 3.1.3. Typical Video Deep Learning Analysis Tasks
    • 3.1.4. Frequently Used Examples
  • 3.2. Introduction to the SDK Package
    • 3.2.1. Obtaining the SDK
    • 3.2.2. Main Modules of the SDK
    • 3.2.3. SDK File Directory
    • 3.2.4. SDK online resource links
• 4. Quick Start
  • 4.1. Quickly run through the SoC mode
    • 4.1.1. Development environment
      • 4.1.1.1. tpu-mlir environment setup
    • 4.1.2. Operating environment
    • 4.1.3. Running YOLOv5 in SoC mode
  • 4.2. Quick run through PCIe mode
    • 4.2.1. Development environment
      • 4.2.1.1. tpu-mlir environment setup
      • 4.2.1.2. libsophon environment setup
      • 4.2.1.3. sophon-mw environment setup
      • 4.2.1.4. sophon-sail environment setup
    • 4.2.2. Runtime environment
    • 4.2.3. Running YOLOv5 in PCIe mode
• 5. MLIR-Model Migration Process
  • 5.1. Overview of MLIR-Migration Tool
  • 5.2. Using TPU-MLIR to Generate FLOAT BModel
    • 5.2.1. Loading tpu-mlir
    • 5.2.2. Preparing the working directory
    • 5.2.3. ONNX to MLIR
  • 5.3. Using TPU-MLIR for Model Quantization
    • 5.3.1. Load tpu-mlir
    • 5.3.2. Prepare the working directory
    • 5.3.3. ONNX to MLIR
    • 5.3.4. MLIR to F16 Model
    • 5.3.5. MLIR to INT8 Model
      • 5.3.5.1. Generating the Calibration Table
      • 5.3.5.2. Compiling to INT8 Symmetric Quantized Model
    • 5.3.6. Effect Comparison
    • 5.3.7. Model performance testing
      • 5.3.7.1. Install the libsophon environment
      • 5.3.7.2. Check the performance of the BModel
• 6. Algorithmic transplant
  • 6.1. Overview of Algorithm Transplantation
    • 6.1.1. Hardware Acceleration Support
    • 6.1.2. C/C++/Python Programming Interfaces
    • 6.1.3. Flowchart of Image Class Algorithm Calls
    • 6.1.4. Flowchart of Image Model Accuracy Debugging
  • 6.2. C/C++ Programming Details
    • 6.2.1. Load bmodel
    • 6.2.2. Preprocessing
      • 6.2.2.1. Preprocessing Initialization
      • 6.2.2.2. Open the video stream
      • 6.2.2.3. Decoding Video Frames
      • 6.2.2.4. Mat to bm_image Conversion
      • 6.2.2.5. Preprocessing
    • 6.2.3. Inference
    • 6.2.4. Post-processing
    • 6.2.5. Summary of algorithm development precautions
  • 6.3. Python Programming Details
    • 6.3.1. Model loading
    • 6.3.2. Preprocessing
    • 6.3.3. Inference
  • 6.4. Decoding Module
    • 6.4.1. OpenCV Decoding
    • 6.4.2. FFmpeg Decoding
  • 6.5. Graphics operation acceleration module
    • 6.5.1. C language programming interface
    • 6.5.2. Python language programming interface
  • 6.6. Model Reasoning
    • 6.6.1. Introduction of C language Interface of BMLib Module
    • 6.6.2. BMRuntime This section describes the interface of module C
    • 6.6.3. Python interface
• 7. Appendix
  • 7.1. Microserver Customized Software Package
    • 7.1.1. Function 1: Packaging and Bag Making Function
    • 7.1.2. Function 2: Packaging Only Function
      • 7.1.2.1. BM1688 & CV186AH
      • 7.1.2.2. BM1684 & BM1684X
  • 7.2. SoC Mode Memory Modification Tool
    • 7.2.1. Tool 1: Modify on SoC using script
      • 7.2.1.1. SE9:
      • 7.2.1.2. SE5, SE7, SE6 computing boards:
    • 7.2.2. Tool 2: Using a graphical program to remotely modify
      • 7.2.2.1. SE9:
      • 7.2.2.2. SE5, SE7, SE6 computing boards:
  • 7.3. SE6/8 Usability Tool Description
    • 7.3.1. Installation and Update
    • 7.3.2. Operation Method
    • 7.3.3. Main Function List
    • 7.3.4. Precautions
  • 7.4. Batch Deployment Tool
    • 7.4.1. Tool Acquisition
    • 7.4.2. Graphical Mode User Guide
      • 7.4.2.1. Graphical Mode Startup Method
      • 7.4.2.2. Graphical Mode Operation Guide
    • 7.4.3. Command Line Mode Usage Guide
      • 7.4.3.1. Command Line Mode Startup Method
      • 7.4.3.2. Command Line Mode Operation Guide
  • 7.5. Microserver External Interface Documentation
    • 7.5.1. Introduction
      • 7.5.1.1. C language demos, user can click to download the demo
      • 7.5.1.2. Protocol Introduction
      • 7.5.1.3. IN/OUT Pin Introduction
      • 7.5.1.4. Relay Introduction
    • 7.5.2. Microserver Device Port Description
      • 7.5.2.1. Microserver Appearance 1
      • 7.5.2.2. Microserver Appearance 2
      • 7.5.2.3. Microserver Appearance 3
    • 7.5.3. Testing RS232 Instructions
      • 7.5.3.1. Loopback Testing
      • 7.5.3.2. Pairwise Testing
    • 7.5.4. Testing RS485 Instructions
      • 7.5.4.1. Pairwise Testing
    • 7.5.5. Testing IN Instructions
    • 7.5.6. Testing OUT Instructions
    • 7.5.7. Testing Relay Instructions
  • 7.6. Flashing Package Type Conversion Tool and TFTP Flashing Method
    • 7.6.1. Acquisition of the Flashing Package Type Conversion Tool
    • 7.6.2. Usage Guide for the Flashing Package Type Conversion Tool
    • 7.6.3. TFTP Flashing Method
  • 7.7. BM1688/CV186AH SDK Source Code Download and Compilation Method
  • 7.8. BM1684(X)_to_BM1688(CV186AH) Compatibility Documentation
    • 7.8.1. Obtaining the BM1688/CV186AH SOPHONSDK
    • 7.8.2. Preparing the BM1688/CV186AH bmodel
    • 7.8.3. Preparing the compilation-dependent SDK
    • 7.8.4. Compatibility Adaptation for SDK Versions ≥1.7
    • 7.8.5. Compatibility Adaptation for SDK Versions <1.7
      • 7.8.5.1. Header File Changes
      • 7.8.5.2. bmcv Changes
      • 7.8.5.3. Changes to ffmpeg
      • 7.8.5.4. Changes to bmlib
      • 7.8.5.5. Changes to bmrt
    • 7.8.6. Preparing the BM1688/CV186AH operating environment
    • 7.8.7. Other precautions