端侧部署

    Paddle Lite是飞桨轻量化推理引擎，为手机、IOT端提供高效推理能力，并广泛整合跨平台硬件，为端侧部署及应用落地问题提供轻量化的部署方案。

    • 电脑（编译Paddle Lite）
    • 安卓手机（armv7或armv8）

    注意： PaddleOCR 移动端部署当前不支持动态图模型，只支持静态图保存的模型。当前PaddleOCR静态图的分支是。

    交叉编译环境用于编译 Paddle Lite 和 PaddleOCR 的C++ demo。 支持多种开发环境，不同开发环境的编译流程请参考对应文档。

    1. Docker
    3. MAC OS

    预测库有两种获取方式：

      1. [推荐]编译Paddle-Lite得到预测库，Paddle-Lite的编译方式如下：

    注意：编译Paddle-Lite获得预测库时，需要打开--with_cv=ON --with_extra=ON两个选项，--arch表示arm版本，这里指定为armv8， 更多编译命令 介绍请参考。

      1. 直接下载预测库，下载链接。

    直接下载预测库并解压后，可以得到inference_lite_lib.android.armv8/文件夹，通过编译Paddle-Lite得到的预测库位于 Paddle-Lite/build.lite.android.armv8.gcc/inference_lite_lib.android.armv8/文件夹下。 预测库的文件目录如下：

    1. inference_lite_lib.android.armv8/
    2. |-- cxx                                        C++ 预测库和头文件
    3. |   |-- include                                C++ 头文件
    4. |   |   |-- paddle_api.h
    5. |   |   |-- paddle_image_preprocess.h
    6. |   |   |-- paddle_lite_factory_helper.h
    7. |   |   |-- paddle_place.h
    8. |   |   |-- paddle_use_kernels.h
    9. |   |   |-- paddle_use_ops.h
    10. |   |   `-- paddle_use_passes.h
    11. |   `-- lib                                           C++预测库
    12. |       |-- libpaddle_api_light_bundled.a             C++静态库
    13. |       `-- libpaddle_light_api_shared.so             C++动态库
    14. |-- java                                     Java预测库
    15. |   |-- jar
    16. |   |   `-- PaddlePredictor.jar
    17. |   |   `-- libpaddle_lite_jni.so
    18. |   `-- src
    19. |-- demo                                     C++和Java示例代码
    20. |   |-- cxx                                  C++  预测库demo
    21. |   `-- java                                 Java 预测库demo

    Paddle-Lite 提供了多种策略来自动优化原始的模型，其中包括量化、子图融合、混合调度、Kernel优选等方法，使用Paddle-lite的opt工具可以自动 对inference模型进行优化，优化后的模型更轻量，模型运行速度更快。

    如果已经准备好了 .nb 结尾的模型文件，可以跳过此步骤。

    下述表格中也提供了一系列中文移动端模型：

    注意：V1.1 3.0M 轻量模型是使用PaddleSlim优化后的，需要配合Paddle-Lite最新预测库使用。

    如果直接使用上述表格中的模型进行部署没有问题，可略过下述步骤，直接阅读 。

    如果要部署的模型不在上述表格中，则需要按照如下步骤获得优化后的模型。

    1. # 如果准备环境时已经clone了Paddle-Lite，则不用重新clone Paddle-Lite
    2. git clone https://github.com/PaddlePaddle/Paddle-Lite.git
    4. git checkout release/v2.7
    5. # 启动编译
    6. ./lite/tools/build.sh build_optimize_tool

    编译完成后，opt文件位于build.opt/lite/api/下，可通过如下方式查看opt的运行选项和使用方式；

    1. cd build.opt/lite/api/
    2. ./opt
    选项说明
    —model_dir待优化的PaddlePaddle模型（非combined形式）的路径
    —model_file待优化的PaddlePaddle模型（combined形式）的网络结构文件路径
    —param_file待优化的PaddlePaddle模型（combined形式）的权重文件路径
    —optimize_out_type输出模型类型，目前支持两种类型：protobuf和naive_buffer，其中naive_buffer是一种更轻量级的序列化/反序列化实现。若您需要在mobile端执行模型预测，请将此选项设置为naive_buffer。默认为protobuf
    —optimize_out优化模型的输出路径
    —valid_targets指定模型可执行的backend，默认为arm。目前可支持x86、arm、opencl、npu、xpu，可以同时指定多个backend(以空格分隔)，Model Optimize Tool将会自动选择最佳方式。如果需要支持华为NPU（Kirin 810/990 Soc搭载的达芬奇架构NPU），应当设置为npu, arm
    —record_tailoring_info当使用 根据模型裁剪库文件 功能时，则设置该选项为true，以记录优化后模型含有的kernel和OP信息，默认为false

    --model_dir适用于待优化的模型是非combined方式，PaddleOCR的inference模型是combined方式，即模型结构和模型参数使用单独一个文件存储。

    下面以PaddleOCR的超轻量中文模型为例，介绍使用编译好的opt文件完成inference模型到Paddle-Lite优化模型的转换。

    转换成功后，当前目录下会多出.nb结尾的文件，即是转换成功的模型文件。

    注意：使用paddle-lite部署时，需要使用opt工具优化后的模型。 opt 工具的输入模型是paddle保存的inference模型

    首先需要进行一些准备工作。

    1. 准备一台arm8的安卓手机，如果编译的预测库和opt文件是armv7，则需要arm7的手机，并修改Makefile中ARM_ABI = arm7。

    2. 打开手机的USB调试选项，选择文件传输模式，连接电脑。

    3. 电脑上安装adb工具，用于调试。 adb安装方式如下：

      3.1. MAC电脑安装ADB:

      1. brew cask install android-platform-tools

      3.2. Linux安装ADB

      1. sudo apt update
      2. sudo apt install -y wget adb

      3.3. Window安装ADB

      打开终端，手机连接电脑，在终端中输入

      1. adb devices

      如果有device输出，则表示安装成功。

    4. 准备优化后的模型、预测库文件、测试图像和使用的字典文件。

    1. git clone https://github.com/PaddlePaddle/PaddleOCR.git
    2. cd PaddleOCR/deploy/lite/
    3. # 按照如下命令运行prepare.sh，将预测库文件、测试图像和使用的字典文件到预测库中的demo/cxx/ocr文件夹下
    4. sh prepare.sh /{lite prediction library path}/inference_lite_lib.android.armv8
    6. # 进入OCR demo的工作目录
    7. cd /{lite prediction library path}/inference_lite_lib.android.armv8/
    8. cd demo/cxx/ocr/
    9. # 将C++预测动态库so文件复制到debug文件夹中
    10. cp ../../../cxx/lib/libpaddle_light_api_shared.so ./debug/

    准备测试图像，以PaddleOCR/doc/imgs/11.jpg为例，将测试的图像复制到demo/cxx/ocr/debug/文件夹下。 准备lite opt工具优化后的模型文件，比如使用ch_ppocr_mobile_v1.1_det_prune_opt.nb，ch_ppocr_mobile_v1.1_rec_quant_opt.nb, ch_ppocr_mobile_cls_quant_opt.nb，模型文件放置在demo/cxx/ocr/debug/文件夹下。

    执行完成后，ocr文件夹下将有如下文件格式：

    1. demo/cxx/ocr/
    2. |-- debug/  
    3. |   |--ch_ppocr_mobile_v1.1_det_prune_opt.nb           优化后的检测模型文件
    4. |   |--ch_ppocr_mobile_cls_quant_opt.nb                优化后的文字方向分类器模型文件
    5. |   |--11.jpg                           待测试图像
    6. |   |--ppocr_keys_v1.txt                中文字典文件
    7. |   |--libpaddle_light_api_shared.so    C++预测库文件
    8. |   |--config.txt                       DB-CRNN超参数配置
    9. |-- config.txt                  DB-CRNN超参数配置
    10. |-- crnn_process.cc             识别模型CRNN的预处理和后处理文件
    11. |-- crnn_process.h
    12. |-- db_post_process.cc          检测模型DB的后处理文件
    13. |-- db_post_process.h
    14. |-- Makefile                    编译文件
    15. |-- ocr_db_crnn.cc              C++预测源文件

    注意：

    1. ppocr_keys_v1.txt是中文字典文件，如果使用的 nb 模型是英文数字或其他语言的模型，需要更换为对应语言的字典。 PaddleOCR 在ppocr/utils/下存放了多种字典，包括：
    1. dict/french_dict.txt     # 法语字典
    2. dict/german_dict.txt     # 德语字典
    3. ic15_dict.txt       # 英文字典
    4. dict/japan_dict.txt      # 日语字典
    5. dict/korean_dict.txt     # 韩语字典
    6. ppocr_keys_v1.txt   # 中文字典
    1. config.txt 包含了检测器、分类器的超参数，如下：
    1. 启动调试

    上述步骤完成后就可以使用adb将文件push到手机上运行，步骤如下：

    1. # 执行编译，得到可执行文件ocr_db_crnn
    2. # ocr_db_crnn可执行文件的使用方式为:
    3. # ./ocr_db_crnn  检测模型文件 方向分类器模型文件  识别模型文件  测试图像路径  字典文件路径
    4. make -j
    5. # 将编译的可执行文件移动到debug文件夹中
    6. mv ocr_db_crnn ./debug/
    7. # 将debug文件夹push到手机上
    8. adb push debug /data/local/tmp/
    9. adb shell
    10. cd /data/local/tmp/debug
    11. export LD_LIBRARY_PATH=${PWD}:$LD_LIBRARY_PATH
    13. ./ocr_db_crnn ch_ppocr_mobile_v1.1_det_prune_opt.nb  ch_ppocr_mobile_v1.1_rec_quant_opt.nb  ch_ppocr_mobile_cls_quant_opt.nb  ./11.jpg  ppocr_keys_v1.txt

    如果对代码做了修改，则需要重新编译并push到手机上。

    运行效果如下：

    Q1：如果想更换模型怎么办，需要重新按照流程走一遍吗？ A1：如果已经走通了上述步骤，更换模型只需要替换 .nb 模型文件即可，同时要注意字典更新

    Q2：换一个图测试怎么做？ A2：替换debug下的.jpg测试图像为你想要测试的图像，adb push 到手机上即可

    Q3：如何封装到手机APP中？ A3：此demo旨在提供能在手机上运行OCR的核心算法部分，PaddleOCR/deploy/android_demo是将这个demo封装到手机app的示例，供参考