Skip to content

Latest commit

 

History

History
235 lines (180 loc) · 12.1 KB

README.md

File metadata and controls

235 lines (180 loc) · 12.1 KB
Raw

Other Language: English

RT-AK 之 K210插件

1. 简介

License img

本项目是 RT-AK 主项目的一个子插件

本项目支持以堪智 K210 芯片为目标硬件平台的 AI 开发，插件内部将会使用嘉楠堪智原厂提供的 NNCase 工具

2. 目录结构

./
├── backend_plugin_k210                 # 将模型信息注册到 RT-AK Lib 后端
│   ├── backend_k210_kpu.c
│   ├── backend_k210_kpu.h
│   └── readme.md
├── datasets                            # 用于模型量化的数据集样例
│   ├── mnist_datasets
│   └── readme.md
├── docs                                # RT-AK 之 K210 插件相关文档
│   ├── images
│   ├── Q&A.md
│   ├── RT-AK之K210插件快速上手.md
│   └── version.md
├── generate_rt_ai_model_h.py
├── k210.c                              # rt_ai_<model_name>_model.c 示例文件
├── k_tools                             # k210 原厂工具以及相关文档
│   ├── kendryte_datasheet_20180919020633.pdf
│   ├── kendryte_standalone_programming_guide_20190704110318_zh-Hans.pdf
│   ├── ncc
│   ├── ncc.exe                         # k210 模型转成 kmodel 模型工具
│   └── readme.md
├── plugin_k210_parser.py               # RT-AK 之 k210 插件运行参数
├── plugin_k210.py                      # RT-AK 之 k210 插件运行
└── README.md

3. 命令行参数详细说明

$$ RT-AK 命令行的参数 = （RT-AK 基础参数 + K210 插件参数） $$

  • RT-AK 基础参数，链接

  • 该部分是 RT-AK 之 K210 插件的参数说明，详见 plugin_k210_parser.py

其中需要注意的是加粗部分的两个参数，请注意看相关描述。

详细的使用说明请阅读后续章节

Parameter Description
--embed_gcc 交叉编译工具链路径，非必须。如果有，则会更改 rt_config.py 文件，如果无指定，则需要在编译的时候指定该工具链路径
--ext_tools NNCase 路径，将模型转换为 kmodel，默认是 ./platforms/k210/k_tools
--inference_type 是否将模型量化为整形，如果是 float，不量化，将不能使用 KPU 加速，默认是 uint8
--dataset 模型量化过程中所需要用到的数据集，只需要在设置 --inference-type 为 uint8 时提供这个参数
--dataset_format 用于指定量化校准集的格式。默认是 image，如果是音频之类的数据集，则需要设置为 raw
--weights_quantize_threshold 控制是否量化 conv2d 和 matmul weights 的阈值。如果 weights 的范围大于这个阈值，nncase 将不会量化它
--output_quantize_threshold 控制是否量化 conv2d 和 matmul weights 的阈值。如果输出的元素个数小于这个阈值，nncase 将不会量化它。
--no_quantized_binary 禁用 quantized binary 算子，nncase 将总是使用 float binary 算子。
--dump_weights_range 是一个调试选项。当它打开时 ncc 会打印出 conv2d weights 的范围。
--input_std 用于指定量化校准集的预处理方法。请看下方补充说明
--input_mean 用于指定量化校准集的预处理方法。请看下方补充说明
--input_type 用于设置推理时输入的数据类型。默认和 inference type 相同。如果 --input-type 是 uint8，推理时你需要提供 RGB888 uint8 张量。如果 --input-type 是 float，你则需要提供 RGB float 张量。
--convert_report 模型转换成 kmodel 的日志输出，默认是 ./platforms/k210/convert_report.txt
--model_types RT-AK Tools 所支持的模型类型，目前模型支持范围：tflite、onnx、caffe
--enable_rt_lib 在 project/rtconfgi.h 中打开宏定义 RT_AI_USE_K210，默认是 RT_AI_USE_K210
--clear 是否需要删除 convert_report.txt ，默认 False
  • --input-std 和 --input-mean 用于指定量化校准集的预处理方法。如上所述 ncc 会将你的图片转换为值域是 [0,1] 布局是 NCHW 的张量，之后 ncc 会使用 y = (x - mean) / std 公式对数据进行归一化。这里有一张参数的参考表。
输入值域 --input-std --input-mean
[0,1] (默认) 1 0
[-1,1] 0.5 0.5
[0,255] 0.0039216 0

4. 插件安装

该插件无需主动安装，

只需要克隆主项目工程：RT-AK

进入到 RT-AK/rt_ai_tools 路径下，

仅需要在执行 python aitools.py --xxx 的同时指定 platform 参数为 K210 即可，插件会自动下载。

5. 命令行运行

需要进入到 RT-AK/rt_ai_tools 路径下，执行下面中的某一条命令

其中 your_project_path 是拥有 RT-Thread 系统的 BSP 路径，这里，我们提供了一份 BSP ，下载地址

上面提供的 BSP 中 K210 的 SDK 是 V0.5.6 版本。

https://github.com/RT-Thread/rt-thread/bsp/k210 下的 SDK 最高到 v0.5.7，但是其中的 v0.5.6 落后于我们提供的 BSP，请以我们提供的 BSP 为准，也欢迎各位同学到 Github 上提 issue 和 pr

# 非量化，不使用 KPU 加速， --inference_type
$ python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=k210  --inference_type=float

# 非量化，指定交叉编译工具链路径
$ python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=k210 --embed_gcc=<your_RISCV-GNU-Compiler_path> --inference_type=float

# 量化为 uint8，使用 KPU 加速，量化数据集为图片
$ python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=k210 --embed_gcc=<your_RISCV-GNU-Compiler_path> --dataset=<your_val_dataset>

# 量化为 uint8，使用 KPU 加速，量化数据集为音频之类非图片，--dataset_format
$ python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=k210 --embed_gcc=<your_RISCV-GNU-Compiler_path> --dataset=<your_val_dataset> --dataset_format=raw

# 示例(量化模型，图片数据集)
$ python aitools.py --project="D:\Project\k210_val" --model="./Models/facelandmark.tflite" --model_name=facelandmark --platform=k210 --embed_gcc="D:\Project\k210_third_tools\xpack-riscv-none-embed-gcc-8.3.0-1.2\bin" --dataset="./platforms/plugin_k210/datasets/images"

其他：

# 指定转换的模型名称，--model_name 默认为 network
$ python aitools.py --project=<your_project_path> --model=<your_model_path> --model_name=<model_name> --platform=k210 --embed_gcc=<your_RISCV-GNU-Compiler_path> --dataset=<your_val_dataset> --clear

# 不保存模型转换日志，--clear
$ python aitools.py --project=<your_project_path> --model=<your_model_path> --platform=k210 --embed_gcc=<your_RISCV-GNU-Compiler_path> --dataset=<your_val_dataset> --clear

6. 项目工程编译

需要准备好交叉编译工具链： xpack-riscv-none-embed-gcc-8.3.0-1.2

设置编译环境：

set RTT_EXEC_PATH=your_toolchains
# 或者修改rtconfig.py 文件，在第22行新增 os.environ['RTT_EXEC_PATH'] = r'your_toolchains'
scons -j 6

如果编译正确无误，会产生 rtthread.elf、rtthread.bin文件。

其中 rtthread.bin 需要烧写到设备中进行运行。

7. 插件内部工作流程

  • 判断模型是否支持
  • 模型转换成 kmodel 模型，保存在 project/applications
  • kmodel 模型转存为十六进制，保存在 project/applications
  • 生成 rt_ai_<model_name>_model.h 文件，保存在 project/applications
  • 生成 rt_ai_<model_name>_model.c 文件，保存在 project/applications
  • 在 project 中写入 RTT_EXEC_PATH 环境变量
  • 判断是否删除 convert_report.txt
  • 自动生成模型推理等应用代码
功能函数 

### 7.1 Function1 - 判断模型是否支持


- 函数：`is_support_model_type(model_types, model)`
- 功能：判断模型类型是否支持
- input: (model_types, model)
- output: model name


### 7.2 Function2 - 转换 kmodel


- 函数：`convert_kmodel(model, project, dataset, kmodel_name, convert_report)`
- 功能：将输入模型转成 `kmodel` 模型，保存路径：`project/applications/.kmodel` ，并将运行日志保存为：`./platforms/k210/convert_report.txt`
- input: (model, project, dataset, kmodel_name, convert_report)
- output: 模型转换的输出日志


### 7.3 Function3 -  转存16进制


- 函数：`hex_read_model(self, project, model)`
- 功能：将 `kmodel` 模型转存为十六进制，`project/applications/_kmodel.c` 
- input: (project, model)


### 7.4 Function4 - 生成 rt_ai_model.h


- 函数：`rt_ai_model_gen(convert_report, project, model_name)`
- 功能：根据 `./platforms/k210/convert_report.txt` 生成 `rt_ai__model.h` 文件
- input: (convert_report, project, model_name)
- output: `rt_ai__model.h` 文件内容


### 7.5 Function5 - 生成 rt_ai_model.c


- 函数：`load_rt_ai_example(rt_ai_example, project, old_name, new_name, platform)`
- 功能：根据 `Documents/k210.c` 生成 `rt_ai__model.c` 文件
- input: (Documents_path, project, default_name, kmodel_name, platform)


### 7.6 Function6 - RTT_EXEC_PATH 环境变量


- 函数：`set_gcc_path(project, embed_gcc)`
- 功能：在 `project/rtthread.py` 文件的第十四行写入 `RTT_EXEC_PATH` 变量，这样就不用在 `env` 中手动指定路径了。
- input: (project, embed_gcc)