Skip to content

README.md

Latest commit

 

History

History
executable file
·
118 lines (100 loc) · 5.46 KB

README.md

File metadata and controls

executable file
·
118 lines (100 loc) · 5.46 KB
Raw

MiniCPM3

目录

1. 简介

MiniCPM3是开源中英双语对话模型，关于它的特性，请前往源repo查看：https://huggingface.co/openbmb/MiniCPM3-4B。 本例程对MiniCPM3进行移植，使之能在SOPHON BM1684X上进行推理测试。

对于BM1684X，该例程支持在V24.04.01(libsophon_0.5.1)及以上的SDK上运行，支持在插有1684X加速卡(SC7系列)的x86/riscv主机上运行，也可以在1684X SoC设备（如SE7、SM7、Airbox等）上运行。在SoC上运行需要额外进行环境配置，请参照运行环境准备完成环境部署。

2. 特性

  • 支持BM1684X(x86 PCIe、SoC、riscv PCIe)
  • 支持INT8、INT4模型编译和推理
  • 支持基于SAIL推理的Python例程
  • 支持多轮对话

3. 运行环境准备

在PCIe上无需修改内存，以下为soc模式相关： 对于1684X系列设备（如SE7/SM7）可以通过这种方式完成环境准备，使得满足MiniCPM3运行条件。参考如下命令修改设备内存。

cd /data/
mkdir memedit && cd memedit
wget -nd https://github.com/sophgo/sophon-tools/releases/download/v24.09.21/memory_edit_v2.10.tar.xz
tar xvf memory_edit_v2.10.tar.xz
cd memory_edit
./memory_edit.sh -p #这个命令会打印当前的内存布局信息

#如果是1684x系列设备，执行以下命令
./memory_edit.sh -c -npu 7615 -vpu 3072 -vpp 3072 #npu也可以访问vpu和vpp的内存
sudo cp /data/memedit/DeviceMemoryModificationKit/memory_edit/emmcboot.itb /boot/emmcboot.itb && sync
sudo reboot

注意：

  1. tpu总内存为npu/vpu/vpp三者之和。
  2. 更多教程请参考SoC内存修改工具

4. 准备模型

已提供编译好的bmodel。

4.1 使用提供的模型

​本例程在scripts目录下提供了下载脚本download.sh

# minicpm3 1684x
./scripts/download.sh bm1684x

执行下载脚本后，当前目录下的文件如下：

├── docs
│   └── MiniCPM3_Export_Guide.md        #MiniCPM3 onnx导出和bmodel编译指南
├── models
│   └── BM1684X                     #download.sh下载的bmodel
│       └── minicpm3-xxx.bmodel
├── pics
│   ├── chat_stream.png
│   ├── multi_session.png
│   └── web_demo.png
├── python
│   ├── minicpm3.py                     #MiniCPM3 python推理脚本
│   ├── openai_api_request.py
│   ├── openai_api_server.py
│   ├── web_demo.py
│   ├── README.md                   #python例程执行指南
│   ├── requirements.txt            #python例程的依赖模块
│   ├── config                      #配置文件
│   │   ├── api.yaml                #openai api server的配置文件
│   │   ├── web.yaml                #web demo的配置文件
│   │   └── minicpm3.yaml           #python demo的配置文件
│   └── token_config                #tokenizer
│       ├── added_tokens.json
│       ├── special_tokens_map.json
│       ├── tokenization_minicpm.py
│       ├── tokenizer_config.json
│       ├── tokenizer.json
│       └── tokenizer.model 
├── README.md                       #MiniCPM3例程指南
├── scripts                         
│   ├── download.sh                 #下载脚本
│   └── gen_bmodel.sh               #模型编译脚本
└── tools
    ├── MiniCPM3-4B-Chat                #修改过的MiniCPM3源码
    │   ├── config.json
    │   └── modeling_minicpm.py
    └── export_onnx.py              #MiniCPM3导出onnx脚本。

4.2 自行编译模型

此部分请参考MiniCPM3模型导出与编译

5. 例程测试

6. 程序性能测试

这里的测试输入为："请使用C++写一段冒泡排序算法。"

测试平台 测试程序 测试模型 first token latency(s) token per second(tokens/s)
SE7-32 minicpm3.py minicpm3-4b_int4_seq512_1dev.bmodel 0.577 12.888
SC7-HP75 minicpm3.py minicpm3-4b_int4_seq512_1dev.bmodel 0.747 7.891
SRM1-20 minicpm3.py minicpm3-4b_int4_seq512_1dev.bmodel 0.860 4.045

测试说明：

  1. 性能测试结果具有一定的波动性，建议多次测试取平均值；
  2. SE7-32的主控处理器为8核 ARM A53 42320 DMIPS @2.3GHz，PCIe上的性能由于处理器的不同可能存在较大差异；
  3. 这里使用的SDK版本是BM1684X V24.04.01；