# ICRAFT TUTORIAL
本仓库主要介绍基于icraft进行模型部署的使用方法。
3.6.2
3.6.2版本开始对tutorial进行了细分，包括：快速开始，icraft编译用法，运行时api用法，计时相关，profiler相关用法等。
3.7.1
3.7.1版本的tutorial则进一步扩充了:icraft性能分析及优化教程、icraft硬算子教程、问题自助排查教程、FAQ等内容。
- 3.7.1 分支下 examples 目录内容：
| 示例 | 内容 |
|---|---|
| Example1_compile | 编译示例（config/fmodel/qtset） |
| Example2_quick_start_python | 快速开始 Python（yolov5 soft/hard、sim/socket/axi、detpost、snapshot） |
| Example3_quick_start_C++ | 快速开始 C++ |
| Example4_basic_C++ | 基础运行时工程 C++ |
| Example5_basic_python | 基础运行时工程 Python(pyrt) |
| Example6_psin_C++ | 仿真(psin) C++ |
| Example7_psin_Python | 仿真(psin) Python |
| Example8_snapshot_C++ | 快照生成与使用 |
| Example9_networkSegmentation_sub_C++ | 复杂网络切分·子网版 |
| Example10_networkSegmentation_view_C++ | 复杂网络切分·视图衔接版(yolov5s 分片 no_mmu) |
| Example11_plin_C++ | plin(Linux 部署)例程 yolov5s_plin |
| Example12_time_analysis | 耗时分析 |
| Example13_plddr_in | plddr_in 部署 |
| Example14_plin_warpaffine | plin + warpaffine 硬算子 |
3.31.0
3.31.0版本的tutorial扩充了:新增环境准备教程、linux系统下的编译教程、imk功能升级及使用示例;本版本提供丰富的示例教程：
- 3.31.0 分支下 examples 目录内容：
| 示例 | 内容 |
|---|---|
| Example1_compile | 编译示例（config/fmodel/qtset） |
| Example2_quick_start_python | 快速开始 Python（yolov5 soft/hard、sim/socket/axi、detpost、snapshot） |
| Example3_quick_start_C++ | 快速开始 C++ |
| Example4_basic_C++ | 基础运行时工程 C++ |
| Example5_basic_python | 基础运行时工程 Python(pyrt) |
| Example6_psin_C++ | 仿真(psin) C++ |
| Example7_psin_Python | 仿真(psin) Python |
| Example8_snapshot_C++ | 快照生成与使用 |
| Example9_networkSegmentation_sub_C++ | 复杂网络切分·子网版 |
| Example10_networkSegmentation_view_C++ | 复杂网络切分·视图衔接版(yolov5s 分片 no_mmu) |
| Example11_plin_C++ | plin(Linux 部署)例程 yolov5s_plin |
| Example12_time_analysis | 耗时分析 |
| Example13_plddr_in | plddr_in 部署 |
| Example14_plin_warpaffine | plin + warpaffine 硬算子 |
| Example15_Usage_in_Linux | Linux 系统下使用示例工程 |
| Example16_plin+psin_C++ | plin+psin 组合例程 |
| Example18_psin_Python_for_sint16 | sint16 量化数据的 psin Python 例程 |
3.33.1
3.33.1版本的tutorial:新增基于ZG架构(如30TAI)的使用教程。使用教程按后端拆分为 BY(BUYI/100TAI) 与 ZG(ZHUGE/30TAI) 两类。
BY(BUYI/100TAI) 示例：demo_for_icraft_by
| 示例 | 内容 |
|---|---|
| Example1_compile | 编译示例（含 customop 自定义激活注册、TensorFlow2Onnx yolov3 导出等） |
| Example2_quick_start_python | 快速开始 Python（yolov5 soft/hard、sim/socket/axi、detpost、snapshot_demo） |
| Example3_quick_start_C++ | 快速开始 C++（build_win/build_arm、cfg/yolov5s.yaml、src/yolov5s.cpp） |
| Example4_basic_python | 基础运行时工程 Python（pyrt，yolov5s_sim/socket.py） |
| Example5_basic_C++ | 基础运行时工程 C++（yolov5s_sim/socket.cpp） |
ZG(ZHUGE/30TAI) 示例：
| 模型仓 | 内容 |
|---|---|
| yolov5_demo_for_icraft_zg | yolov5 ZG 全流程工程：compile/（config/yolov5s_ZG.toml、fmodel、qtset、imodel）+ deploy/（含 cfg/yolov5s_psin.yaml、pyrt/yolov5_psin.py、src/yolov5s_psin.cpp 的 psin 仿真）+ modelzoo_utils/ + lib/aarch64-linux-gnu/ 运行时库 |
| runtime_demo_for_icraft_zg_py | Python(PYRT) 运行时工程：yolov5_socket.py（socket 仿真）、yolov5_axi.py（上板，含 calctime）、preprocess/postprocess/visualize、imodel/yolov5s |
| runtime_demo_for_icraft_zg_cpp | C++(CRT) 运行时工程：socket/（yolov5s_psin.cpp 仿真，build_win）+ axi/（上板工程，build_arm），含 PicPre/postprocess_yolov5.hpp |
版本分支指引
模型库指引
更多模型与示例可关注icraft模型库：