mdz/pytorch/siamrpn++
guyiyun 3231f3e19f 🔧 refactor: update submodules 2025-06-25 09:34:30 +08:00
..
1_scripts 🎉 feat: initialize modelzoo_v3.7.1 2024-12-31 15:13:58 +08:00
2_compile 🎉 feat: initialize modelzoo_v3.7.1 2024-12-31 15:13:58 +08:00
3_deploy 🔧 refactor: update submodules 2025-06-25 09:34:30 +08:00
download.ps1 🔧 refactor: update the format in download scripts 2025-06-25 09:29:04 +08:00
download.sh 🔧 refactor: update the format in download scripts 2025-06-25 09:29:04 +08:00
readme.md 📜 docs: update readme.md 2025-04-18 13:56:53 +08:00

readme.md

siamrpn++

version author
metrics speed
FPGA_ops
模型清单
OS

下载

一键下载开发流程中所需的各种文件,包括编译使用的量化校准集、运行时工程的依赖库,以及输入输出文件。

💡 推荐使用linux版下载脚本其wget包含断网自动重连功能不会出现下载文件遗漏情况。

windows

📌 第一次使用请在C盘根目录下新建icraft_auth.txt,保存下载站账号密码,以换行符分隔

需要事先下载windows版本wget

(若点击以下链接后未直接下载,请选择 1.20.3 版本下的对应系统链接进行下载)

x86系统wget下载 x64系统wget下载

使用时需要将wget.exe的路径作为命令行参数传入注意不是exe的父文件夹目录而是包含wget.exe的完整绝对路径

不下载Deps./download.ps1 "PATH_TO_WGET_EXE"

如果您是第一次使用我们的模型库,请下载包括工程依赖库的所有文件:./download.ps1 "PATH_TO_WGET_EXE" -d

💡 下载过程中可能因网络问题出现中断情况,需 自行重新运行 下载脚本。

linux

📌 第一次使用,请在/usr根目录下新建icraft_auth.txt,保存下载站账号密码,以换行符分隔

为确保文件格式正确,请在运行脚本前安装格式转换工具dos2unix,并执行格式转换命令:

sudo apt-get install dos2unix
dos2unix /usr/icraft_auth.txt
dos2unix ./download.sh

如果您是第一次使用我们的模型库,请下载包括工程依赖库的所有文件:./download.sh -d

如果之前已经在使用别的模型时下载过Deps依赖库可以直接将其中的thirdparty部分复制到路径3_deploy/Deps,只需下载量化校准集和输入输出文件即可:./download.sh

🌟 Tips

  • 若想要直接获取原始weights和导出保存的模型可分别前往 weightsfmodels 网页上根据框架及模型名寻找并下载。

0. 文件结构说明

AI部署模型需要以下几部分文件

  • 0_A2Net >修改后的模型工程,需要自行下载

  • 1_scripts >若干脚本用于保存Icraft编译器需要的模型

  • 2_compile >Icraft编译器编译模型时所需要的文件

  • 3_deploy >将Icraft编译器编译出的模型部署到硬件时需要的c++工程

1. python工程准备

1. 模型来源:

2. 保存模型

目的将模型保存成可以被Icraft编译器编译的形态

1_scripts提供脚本说明

  • 环境要求:Icraft编译器对导出框架模型时使用的框架版本有要求。即以下脚本中所有导出模型的脚本1_save.py ,必须在要求的框架版本下执行,其他脚本不限制。要求的版本:
    • pytorch支持pytorch1.9.0、pytorch2.0.1两个版本的原生网络模型文件(.pt格式以及pytorch框架保存为onnxopset=17格式的模型文件.onnx格式
    • paddle仅支持PaddlePaddle框架保存为onnxopset=11格式的模型文件.onnx格式不支持框架原生网络模型文件
  • 0_infer.py >可以推理一张图并得到最终结果,需要预先下载好模型权重
  • 1_save_xx.py >保存模型保存好的用于Icraft编译器的模型会存放在 /2_compile/fmodel

2.使用Icraft编译器编译模型

目的: 使用Icraft编译器将上一步保存好的框架模型转化为硬件可部署模型

  • 1相关命名说明

    1fmodelframe model >用于Icraft编译器的框架模型

    2imodelicraft model >用Icraft编译器编译出的模型

    3qtsetQuantitative Calibration Set >Icraft编译器所需的量化校准集

  • 2确认已安装正确的icraft版本

    检查方法打开cmd运行icraft --version

    若已正常安装则会显示当前icraft版本例如

    Icraft 版本:
     * 3.7.1
    
    CLI 版本:
    3.7.0.0-a90988f(2412231401)
    
  • 3执行编译:

    /2_compile目录下执行编译:

     icraft compile config/siamrpn++-net-1_psin_8.toml
     icraft compile config/siamrpn++-net-2_psin_8.toml
    
    如果过程顺利,将得到 icraft model以 `.json` graph`.raw`param的格式保存
    
    其中包括编译各阶段产生的中间结果模型和最终用于片上部署的BY模型直接被保存到:  3_deploy/modelzoo/siamrpn++/imodel
    

3. 部署模型

部署环境检查

  • 以root账户登录片上系统terminalssh或串口皆可模型库默认的模型存放路径为以下目录如果没有请预先创建
/home/fmsh/ModelZoo/
  • 检查板上环境是否正确:
    1. 查看环境变量,指令: icraft --version

      看打印信息是否如下:

      Icraft 版本:
      * v3.7.1
      
      CLI 版本:
      3.7.0.0-a90988f(2412231401)
      
    2. 若是,在任意目录下输入icraft-serve即可打开server

    3. 检查icraft和customop安装包版本是否为arm64

      # 检查icraft安装包版本
      dpkg -l | grep icraft
      # 检查customop安装包版本
      dpkg -l | grep customop
      

      如果依次显示如下信息,则安装版本正确:

      ii  icraft                         3.7.1                             arm64        This is Icraft for arm64
      ii  customop                       3.7.1                             arm64        This is Icraft CustomOp for arm64
      
    4. 如果环境配置有误,请参考Part 1_1 2.3.1 片上系统环境 编译环境准备进行部署环境配置。

    5. 根据此模型使用的硬算子,选择合适的位流,并在板上安装,所用硬算子及可选位流版本可参见本说明文档起始处的状态徽章,位流下载及安装说明请参考1/4) 其他下载资源

c++ runtime:

目的编译c/c++可执行程序在AI硬件上执行模型前向推理

模型库以ubuntu操作系统为例

  1. 编译环境准备

    • os: ubuntu20.04
    • cmake>=3.10
    • compiler: aarch64-linux-gnu-g++/aarch64-linux-gnu-gcc 编译c++程序
    #在3.1所需的linux编译环境中
    cd 3_deploy/modelzoo/siamrpn++/build_arm
    cmake ..
    make -j
    
  2. 执行程序

    cd /home/fmsh/ModelZoo/modelzoo/siamrpn++/build_arm
    chmod 777 *
    ./siamrpn++_psin ../cfg/siamrpn++_psin.yaml
    

    在io/output中查看结果

4. 精度测试

由于精度测试需要遍历一个数据集中的所有图片因此需要使用上位机作为主控操作系统demo中是按windows作为上位机操作系统来做的使用网口连接板子运行时输入数据会通过上位机经由网口传到片上进行推理。

1. 环境准备

若已准备好环境请跳过此部分

1. 网口调试环境准备(如果已经准备好网口调试环境则看下一条)

  1. 安装ssh

  2. 查看或配置板子ip

    • 使用串口连接板子
    • vim /etc/rc.local
    • 查看或设置ip
    #!/bin/bash
    ifconfig eth0 192.168.125.171 netmask 255.255.255.0
    systemctl start sshd
    
  3. 修改本地网络适配器配置

    参考配置

    • ipv4地址192.168.125.2
    • 子网掩码:255.255.255.0
    • 默认网关:192.168.125.1
    • 连接速度与双工100mbps全双工
  4. 使用网口或串口进入板上系统打开server

    上位机:

    ssh root@192.168.125.171
    

    板上: 确保位于root账户下执行

    icraft-serve
    
    • 请确保在root账户下执行上述命令
    • 设备成功打开示意图
    root@U:~# icraft-serve
    [02/22/24 02:02:00.388] [I] Using port : 9981
    [02/22/24 02:02:00.388] [I] synchronous mode
    [02/22/24 02:02:00.388] [I] [irpc::port::tcp::_waitNewConn] wait for new connection
    

    如果能正确运行则可以继续下一步。

2.编译环境准备

请参考2.1Windows编译环境准备进行精度测试环境配置。

2. 测试说明

1.数据集准备

  • 测试数据集下载:LaSOT
  • 模型测试使用LaSOT数据集中随机抽取的部分数据集(共62个seqs),测试序列存放于 3_deploy\modelzoo\siamrpn++\io\input3_deploy\modelzoo\siamrpn++\io\Lasot_sub62.txt
  • 如需测试其他数据集,需自行将图片存放于 3_deploy\modelzoo\siamrpn++\io\input,并准备对应的input.txt

2.修改 运行时的yaml配置文件

运行时需要配置一些模型路径,输入数据,后处理参数等,其配置文件在 3_deploy/modelzoo/siamrpn++/cfg/

测试时使用:siamrpn++_psin_test.yaml

需要修改:

  • imodel中参数修改精度测试所用模型文件路径dir根据所使用板子ip设置ip
  • dataset中参数更改自己的精度测试数据集路径。
  • param中参数如果模型没有重训则无需更改若 重训则需要修改对应部分参数。

3.编译、执行运行时程序

./siamrpn++_psin ../cfg/siamrpn++_psin_test.yaml

4.使用metrics测试脚本将保存的测试结果计算出精度指标

metrics测试脚本使用与配置说明

5. 模型性能记录

时间测试如下:

siamrpn++ input shape hard time
siamrpn++-net-1-8bit [1,3,127,127] 1.52 ms
siamrpn++-net-2-8bit [1,3,225,225] 5.391 ms
siamrpn++-net-1-16bit [1,3,127,127] 2.96 ms
siamrpn++-net-2-16bit [1,3,225,225] 12.008 ms

精度测试如下:

siamrpn++ qt_strategy AUC Precision Precision_norm
float - 45.30 45.62 53.62
8bit kld-pt 44.12 43.94 52.87
16bit kld-pt 45.23 45.11 53.64