History

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	🐛 fix: update configs of pre_mean and pre_scale in toml	2025-06-20 18:24:46 +08:00
3_deploy	🔧 refactor: update submodules	2025-06-25 09:34:30 +08:00
download.ps1	🔧 refactor: revise the Yaml_path in pyrt	2025-02-28 18:00:44 +08:00
download.sh	🔧 refactor: revise the Yaml_path in pyrt	2025-02-28 18:00:44 +08:00
readme.md	📜 docs: update readme.md	2025-04-18 13:56:53 +08:00

readme.md

ETTrack

下载

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

💡 推荐使用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和导出保存的模型，可分别前往 weights 和 fmodels 网页上根据框架及模型名寻找并下载。

0. 文件结构说明

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

0_ETTrack >模型原始工程，需要自行下载
1_scripts >若干脚本，用于保存Icraft编译器需要的模型、编译后仿真等功能
2_compile >Icraft编译器编译模型时所需要的文件
3_deploy >将Icraft编译器编译出的模型部署到硬件时需要的c++工程

1. python工程准备

1. 模型来源：

code：https://github.com/pblatter/ettrack
branch：main
commit_id：d60e393
weights：https://github.com/pblatter/ettrack/blob/main/checkpoints/et_tracker/checkpoint_e35.pth（权重无需自行下载，在源码工程checkpoints文件夹下）

2. 保存模型

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

1）根据模型来源中的地址，下载指定commit id版本的源代码，文件夹名称要设置为：0_ETTrack

# 在此模型根目录
mkdir 0_ETTrack
git clone -b main https://github.com/pblatter/ettrack 0_ETTrack
cd 0_ETTrack
git checkout d60e393

3）将1_scripts中文件复制到0_ETTrack中，执行保存模型脚本1_save.py

# 在此模型根目录
cd 0_ETTrack
python 1_save.py

1_scripts提供脚本说明：

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

保存模型时的修改点：

对tracking/basic_model/exemplar_transformer.py进行修改。为了消除floor_divide算子，需要构建4个不同参数的ExemplarTransformer，重写forward：

ExemplarTransformer256_5
ExemplarTransformer256_3
ExemplarTransformer192_3
ExemplarTransformer192_5
对应修改ET_Tracker类中init函数对ExemplarTransformer的调用，详见1_save.py中的ET_Tracker__init__()函数；

ExemplarTransformer的主要修改点：
①计算Keys外积的时候，提前在外部将K的转置算好，详见1_save.py中的ET_Tracker_template()函数。
②将einsum替换为matmul计算；
③去除floor_divide算子，提前算好dw_weight_shape、pw_weight_shape；
④去除无效view算子；

2、将字典传输数据的方式展开，对应更改Point_Neck_Mobile_simple_DP模块的前向函数、ET_Tracker的前向函数;

3、去除不支持的unbind，用slice的方式等效替换，详见1_save.py中的MlpHead_forward()函数；

4、采用matmul来等效替换*和torch.sum操作，详见1_save.py中的MlpHead_forward()函数；

5、修改TransconverTracker的initialize函数，固定网格大小为18x18，原来是会根据初始框大小在原始帧占比决定网格大小是18x18还是16x16；详见1_save.py中的TransconverTracker_initialize()函数;
2_save_infer.py >用修改后保存的模型做前向推理，验证保存的模型与原模型是否一致

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

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

1）相关命名说明：

1）fmodel：frame model >用于Icraft编译器的框架模型

2）imodel：icraft model >用Icraft编译器编译出的模型

3）qtset：Quantitative Calibration Set >Icraft编译器所需的量化校准集
2）确认已安装正确的icraft版本

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

若已正常安装则会显示当前icraft版本，例如：
```
Icraft 版本:
 * 3.7.1

CLI 版本:
3.7.0.0-a90988f(2412231401)
```

3）执行编译： 在 /2_compile目录下执行编译：

 #net1编译
 icraft compile config/ettrack_net1_8.toml  
 #net2编译
 icraft compile config/ettrack_net2_8.toml

如果过程顺利，将得到 icraft model（以 .json （graph）.raw（param）的格式保存）其中包括编译各阶段产生的中间结果模型和最终用于片上部署的BY模型，直接被保存到: 3_deploy/modelzoo/ETTrack/imodel中

3. 仿真

通过配置3_deploy/modelzoo/ETTrack/cfg/中yaml文件的sim字段为True实现模型仿真。

imodel:
   ...
   sim: true
   ...

4. 部署模型

部署环境检查

以root账户登录片上系统terminal（ssh或串口皆可），模型库默认的模型存放路径为以下目录，如果没有请预先创建：

/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) 其他下载资源。

python runtime:

目的：在AI硬件上执行模型前向推理

python运行环境要求与准备
- python版本：3.8（否则无法使用icraft的python API）

确保已安装icraft的python安装包
- socket模式使用：pip install icraft-3.x.x-cp38-none-win_amd64.whl
- axi模式使用：pip install icraft-3.x.x-cp38-none-manylinux2014_aarch64.whl
- 安装python运行时所需要的依赖包
```
cd 3_deploy/modelzoo/ETTrack
pip install -r requirements.txt
```
- 安装一些便于开发pyrt的依赖包
```
cd 3_deploy/Deps/modelzoo
pip install -e .
```
由于python运行时代码在引入依赖包时候已经通过sys.path.append(R"../../../Deps/modelzoo")将一些便于开发pyrt的依赖包加入到了系统路径下，因此可以不用执行该步骤即可直接运行2.执行程序。这里提供额外的[pip install -e .]安装方式是为了在python运行时代码时候方便进行pyrtutils的依赖跳转。

执行程序

python ./ettrack_psin.py ../cfg/ettrack.yaml

在io/output中查看结果

5. 精度测试

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

1. 环境准备

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

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

安装ssh

查看或配置板子ip

使用串口连接板子
vim /etc/rc.local
查看或设置ip

#!/bin/bash
ifconfig eth0 192.168.125.171 netmask 255.255.255.0
systemctl start sshd

修改本地网络适配器配置

参考配置
- ipv4地址：192.168.125.2
- 子网掩码：255.255.255.0
- 默认网关：192.168.125.1
- 连接速度与双工：100mbps全双工

使用网口或串口进入板上系统打开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. 测试说明

数据集准备

测试数据集下载：LaSOT
模型测试使用LaSOT数据集中随机抽取的部分数据集，测试序列存放于 3_deploy\modelzoo\ETTrack\io\input及 3_deploy\modelzoo\ETTrack\io\list.txt中
如需测试其他数据集，需自行将图片存放于 3_deploy\modelzoo\ETTrack\io\input,并准备对应的input.txt

修改运行时的yaml配置文件：

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

测试时使用：ettrack.yaml

需要修改：
- imodel中参数：修改精度测试所用模型文件路径dir，根据所使用板子ip设置ip。
- dataset中参数：更改自己的精度测试数据集路径。
- param中参数：如果模型没有重训，则无需更改，若重训则需要修改对应部分参数。
编译、执行运行时程序

python运行时：

cd 3_deploy/modelzoo/ETTrack/pyrt
python ./ettrack_psin.py ../cfg/ettrack.yaml

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

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

精度测试脚本存放于：https://gitee.com/mxh-spiger/benchmark
本模型使用 ./sot_track/analysis_results.py

6. 模型性能记录

时间测试如下：

ETTrack	input shape	hard time
ETTrack-net1-8bit	[1, 3, 127, 127]	1.778ms
ETTrack-net2-8bit	[1, 3, 288, 288]	16.763ms
ETTrack-net1-16bit	[1, 3, 127, 127]	3.24ms
ETTrack-net2-16bit	[1, 3, 288, 288]	32.918ms

精度测试如下：

ETTrack	qt_strategy	AUC	Precision	Precision_norm
float	-	59.3	60.12	68.01
8bit	kld-pc&null_pt	12.54	4.15	8.40
16bit	kld-pc&null_pt	54.39	54.04	62.10

readme.md Unescape Escape