mirrors
/
PaddleClas
mirror of https://github.com/PaddlePaddle/PaddleClas.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
PaddleClas/docs/zh_CN/deployment/PP-ShiTu/cpp.md

15 KiB
Raw Blame History

服务器端C++预测

本教程将介绍在服务器端部署PP-ShiTu的详细步骤。

目录

1. 准备环境

运行准备

  • Linux环境，推荐使用ubuntu docker。

1.1 升级cmake

由于依赖库编译需要较高版本的cmake，因此，第一步首先将cmake升级。

  • 下载最新版本cmake

    # 当前版本最新为3.22.0，根据实际情况自行下载，建议最新版本
wget https://github.com/Kitware/CMake/releases/download/v3.22.0/cmake-3.22.0.tar.gz
tar -xf cmake-3.22.0.tar.gz

    最终可以在当前目录下看到cmake-3.22.0/的文件夹。

  • 编译cmake，首先设置cmake源码路径(root_path)以及安装路径(install_path)，root_path为下载的cmake源码路径，install_path为cmake的安装路径。在本例中，源码路径即为当前目录下的cmake-3.22.0/。

    cd ./cmake-3.22.0
export root_path=$PWD
export install_path=${root_path}/cmake

  • 然后在cmake源码路径下，执行以下命令进行编译

    ./bootstrap --prefix=${install_path}
make -j
make install

  • 编译安装cmake完成后，设置cmake的环境变量供后续程序使用

    export PATH=${install_path}/bin:$PATH
#检查是否正常使用
cmake --version

此时cmake就可以正常使用了

1.2 编译opencv库

  • 首先需要从opencv官网上下载在Linux环境下源码编译的包，以3.4.7版本为例，下载及解压缩命令如下：

    wget https://paddleocr.bj.bcebos.com/dygraph_v2.0/test/opencv-3.4.7.tar.gz
tar -xvf 3.4.7.tar.gz

    最终可以在当前目录下看到opencv-3.4.7/的文件夹。

  • 编译opencv，首先设置opencv源码路径(root_path)以及安装路径(install_path)，root_path为下载的opencv源码路径，install_path为opencv的安装路径。在本例中，源码路径即为当前目录下的opencv-3.4.7/。

    # 进入deploy/cpp_shitu目录
cd deploy/cpp_shitu

# 安装opencv
cd ./opencv-3.4.7
export root_path=$PWD
export install_path=${root_path}/opencv3

  • 然后在opencv源码路径下，按照下面的方式进行编译。

    rm -rf build
mkdir build
cd build

cmake .. \
    -DCMAKE_INSTALL_PREFIX=${install_path} \
    -DCMAKE_BUILD_TYPE=Release \
    -DBUILD_SHARED_LIBS=OFF \
    -DWITH_IPP=OFF \
    -DBUILD_IPP_IW=OFF \
    -DWITH_LAPACK=OFF \
    -DWITH_EIGEN=OFF \
    -DCMAKE_INSTALL_LIBDIR=lib64 \
    -DWITH_ZLIB=ON \
    -DBUILD_ZLIB=ON \
    -DWITH_JPEG=ON \
    -DBUILD_JPEG=ON \
    -DWITH_PNG=ON \
    -DBUILD_PNG=ON \
    -DWITH_TIFF=ON \
    -DBUILD_TIFF=ON

make -j
make install

  • make install完成之后，会在该文件夹下生成opencv头文件和库文件，用于后面的PaddleClas代码编译。

    以opencv3.4.7版本为例，最终在安装路径下的文件结构如下所示。注意：不同的opencv版本，下述的文件结构可能不同。

    opencv3/
├── bin
├── include
├── lib
├── lib64
└── share

1.3 下载或者编译Paddle预测库

  • 有2种方式获取Paddle预测库，下面进行详细介绍。

1.3.1 预测库源码编译

  • 如果希望获取最新预测库特性，可以从Paddle github上克隆最新代码，源码编译预测库。

  • 可以参考Paddle预测库官网的说明，从github上获取Paddle代码，然后进行编译，生成最新的预测库。使用git获取代码方法如下。

    # 进入deploy/cpp_shitu目录
cd deploy/cpp_shitu

git clone https://github.com/PaddlePaddle/Paddle.git

  • 进入Paddle目录后，使用如下方法编译。

    rm -rf build
mkdir build
cd build

cmake  .. \
    -DWITH_CONTRIB=OFF \
    -DWITH_MKL=ON \
    -DWITH_MKLDNN=ON  \
    -DWITH_TESTING=OFF \
    -DCMAKE_BUILD_TYPE=Release \
    -DWITH_INFERENCE_API_TEST=OFF \
    -DON_INFER=ON \
    -DWITH_PYTHON=ON

make -j
make inference_lib_dist

    更多编译参数选项可以参考Paddle C++预测库官网。

  • 编译完成之后，可以在build/paddle_inference_install_dir/文件下看到生成了以下文件及文件夹。

    build/paddle_inference_install_dir/
├── CMakeCache.txt
├── paddle
├── third_party
└── version.txt

    其中paddle就是之后进行C++预测时所需的Paddle库，version.txt中包含当前预测库的版本信息。

1.3.2 直接下载安装

  • Paddle预测库官网上提供了不同cuda版本的Linux预测库，可以在官网查看并选择合适的预测库版本，注意必须选择develop版本。

    以https://paddle-inference-lib.bj.bcebos.com/2.1.1-gpu-cuda10.2-cudnn8.1-mkl-gcc8.2/paddle_inference.tgz的develop版本为例，使用下述命令下载并解压：

    # 进入deploy/cpp_shitu目录
cd deploy/cpp_shitu

wget https://paddle-inference-lib.bj.bcebos.com/2.1.1-gpu-cuda10.2-cudnn8.1-mkl-gcc8.2/paddle_inference.tgz

tar -xvf paddle_inference.tgz

    最终会在当前的文件夹中生成paddle_inference/的子文件夹。

1.4 安装faiss库

在安装faiss前，请安装openblas，ubuntu系统中安装命令如下：

apt-get install libopenblas-dev

然后按照以下命令编译并安装faiss

# 进入deploy/cpp_shitu目录
cd deploy/cpp_shitu

# 下载 faiss
git clone https://github.com/facebookresearch/faiss.git
cd faiss
export faiss_install_path=$PWD/faiss_install
cmake -B build . -DFAISS_ENABLE_PYTHON=OFF  -DCMAKE_INSTALL_PREFIX=${faiss_install_path}
make -C build -j faiss
make -C build install

注意本教程以安装faiss cpu版本为例，安装时请参考faiss官网文档，根据需求自行安装。

2. 代码编译

编译命令如下，其中Paddle C++预测库、opencv等其他依赖库的地址需要换成自己机器上的实际地址。同时，编译过程中需要下载编译yaml-cpp等C++库，请保持联网环境。

# 进入deploy/cpp_shitu目录
cd deploy/cpp_shitu

sh tools/build.sh

具体地，tools/build.sh中内容如下，请根据具体路径和配置情况进行修改。

OPENCV_DIR=${opencv_install_dir}
LIB_DIR=${paddle_inference_dir}
CUDA_LIB_DIR=/usr/local/cuda/lib64
CUDNN_LIB_DIR=/usr/lib/x86_64-linux-gnu/
FAISS_DIR=${faiss_install_dir}
FAISS_WITH_MKL=OFF

BUILD_DIR=build
rm -rf ${BUILD_DIR}
mkdir ${BUILD_DIR}
cd ${BUILD_DIR}
cmake .. \
    -DPADDLE_LIB=${LIB_DIR} \
    -DWITH_MKL=ON \
    -DWITH_GPU=OFF \
    -DWITH_STATIC_LIB=OFF \
    -DUSE_TENSORRT=OFF \
    -DOPENCV_DIR=${OPENCV_DIR} \
    -DCUDNN_LIB=${CUDNN_LIB_DIR} \
    -DCUDA_LIB=${CUDA_LIB_DIR} \
    -DFAISS_DIR=${FAISS_DIR} \
    -DFAISS_WITH_MKL=${FAISS_WITH_MKL}

make -j
cd ..

上述命令中，

  • OPENCV_DIR：opencv编译安装的地址（本例中为opencv-3.4.7/opencv3文件夹的路径）；
  • LIB_DIR：下载的Paddle预测库（paddle_inference文件夹），或编译生成的Paddle预测库（build/paddle_inference_install_dir文件夹）的路径；
  • CUDA_LIB_DIR：cuda库文件地址，在docker中为/usr/local/cuda/lib64；
  • CUDNN_LIB_DIR：cudnn库文件地址，在docker中为/usr/lib/x86_64-linux-gnu/。
  • TENSORRT_DIR：tensorrt库文件地址，在dokcer中为/usr/local/TensorRT6-cuda10.0-cudnn7/，TensorRT需要结合GPU使用。
  • FAISS_DIR：faiss的安装地址
  • FAISS_WITH_MKL：指在编译faiss的过程中是否使用mkldnn，本文档中编译faiss没有使用，而使用了openblas，故设置为OFF，若使用了mkldnn则为ON.

在执行上述命令，编译完成之后，会在当前路径下生成build文件夹，其中生成一个名为pp_shitu的可执行文件。

3. 运行demo

  • 按照如下命令下载好相应的轻量级通用主体检测模型、轻量级通用识别模型及瓶装饮料测试数据并解压。

    # 进入deploy目录
cd deploy/

mkdir models
cd models

# 下载并解压主体检测模型
wget https://paddle-imagenet-models-name.bj.bcebos.com/dygraph/rec/models/inference/picodet_PPLCNet_x2_5_mainbody_lite_v1.0_infer.tar
tar -xf picodet_PPLCNet_x2_5_mainbody_lite_v1.0_infer.tar

# 下载并解压特征提取模型
wget https://paddle-imagenet-models-name.bj.bcebos.com/dygraph/rec/models/inference/PP-ShiTuV2/general_PPLCNetV2_base_pretrained_v1.0_infer.tar
tar -xf general_PPLCNetV2_base_pretrained_v1.0_infer.tar
cd ..

mkdir data
cd data
wget https://paddle-imagenet-models-name.bj.bcebos.com/dygraph/rec/data/drink_dataset_v2.0.tar
tar -xf drink_dataset_v2.0.tar
cd ..

  • 将相应的yaml文件拷到当前文件夹下

    cp ../configs/inference_drink.yaml ./

  • 将inference_drink.yaml中的相对路径，改成基于 deploy/cpp_shitu 目录的相对路径或者绝对路径。涉及到的参数有

    • Global.infer_imgs ：此参数可以是具体的图像地址，也可以是图像集所在的目录
    • Global.det_inference_model_dir ： 检测模型存储目录
    • Global.rec_inference_model_dir ： 识别模型存储目录
    • IndexProcess.index_dir ： 检索库的存储目录，在示例中，检索库在下载的demo数据中。

  • 标签文件转换

    由于python的检索库的字典是使用pickle转换得到的序列化存储结果，导致C++不方便读取，因此需要先转换成普通的文本文件。

    python3.7 tools/transform_id_map.py -c inference_drink.yaml

    转换成功后，在IndexProcess.index_dir目录下生成id_map.txt，以便在C++推理时读取。

  • 执行程序

    ./build/pp_shitu -c inference_drink.yaml

    默认以 ../drink_dataset_v2.0/test_images/100.jpeg 作为输入图像，则执行上述推理命令可以得到如下结果

    ../drink_dataset_v2.0/test_images/100.jpeg:
      result0: bbox[437, 72, 660, 723], score: 0.769916, label: 元气森林
      result1: bbox[220, 71, 449, 685], score: 0.695485, label: 元气森林
      result2: bbox[795, 104, 979, 653], score: 0.626963, label: 元气森林

    识别流程支持灵活配置，用户可以选择不使用主体检测模型，而直接将单幅整图输入到特征提取模型，计算特征向量供后续检索使用，从而减少整体识别流程的耗时。只需将Global.det_inference_model_dir后的字段改为null或者""，再运行以下推理命令即可

    ./build/pp_shitu -c inference_drink.yaml

    最终输出结果如下

    Found 'Global.det_inference_model_dir' empty, so det_predictor is disabled
../drink_dataset_v2.0/test_images/100.jpeg:
        result0: bbox[0, 0, 1199, 801], score: 0.568903, label: 元气森林

    由于python和C++的opencv实现存在部分不同，可能导致python推理和C++推理结果有微小差异。但基本不影响最终的检索结果。

4. 使用自己模型

使用自己训练的模型，可以参考模型导出，导出inference model，用于模型预测。

同时注意修改yaml文件中具体参数。

5. Windows环境源码编译

  • 5.1 下载安装CMake

  • 5.2 下载源码 (需要使用VS 2019以上版本进行编译)

  • 5.3 下载Widows推理库 注意：推理库需要根据实际情况下载对应的版本

  • 5.4 下载或编译OpenCV

  • 5.5 下载或编译faiss

  • 5.6 下载或编译OpenBLAS(若启用)

  • 5.7 下载安装MKL(若启用) 配置环境变量

  • 5.8 下载安装cuda(若启用) 配置环境变量

  • 5.9 使用CMake生成解决方案

    打开CMake-gui

源码路径选择 xx../PaddleClas/deploy/cpp_shitu

解决方案生成位置填写 xx../PaddleClas/deploy/cpp_shitu/build

OPENCV_DIR填写OpenCV的lib文件所在路径，如 xx../opencv/build/x64/vc15/lib

OpenCV_DIR填写OpenCV的cmake文件所在路径，如 xx../opencv/build

faiss_DIR填写faiss的cmake文件所在路径，如 xx../faiss/share/faiss

根据自己实际情况填写 CUDA_LIB,CUDNN_LIB,FAISS_WITH_MKL,WITH_GPU,WITH_MKL

    点击-Configure，没有错误之后， 点击Generate， 点击Open Project。

    经过上述步骤，源码已经在VS中打开，解决方案文件均已生成，在 xx../PaddleClas/deploy/cpp_shitu/build 路径。 如果生成异常，可以清空该路径重新执行上述步骤。

  • 5.10 编译源码

    在VS中，打开pp_shitu项目，编辑CMakeLists.txt文件。

  option(WITH_MKL        "Compile demo with MKL/OpenBlas support, default use MKL."       ON)#根据实际情况调整
  option(WITH_GPU        "Compile demo with GPU/CPU, default use CPU."                    OFF)#根据实际情况调整
  option(WITH_STATIC_LIB "Compile demo with static/shared library, default use static."   ON)#根据实际情况调整
  option(WITH_TENSORRT "Compile demo with TensorRT."   OFF)#根据实际情况调整
  option(FAISS_WITH_MKL "Faiss Compile demo with MKL."   OFF)#根据实际情况调整
  
  SET(PADDLE_LIB "填写推理库所在的路径，5.3解压路径")
  SET(OPENCV_DIR "" CACHE PATH "Location of libraries")
  SET(CUDA_LIB "" CACHE PATH "Location of libraries") #填写CUDA_LIB所在的路径（若需要）
  SET(CUDNN_LIB "" CACHE PATH "Location of libraries") #填写CUDNN_LIB所在的路径（若需要）
  SET(TENSORRT_DIR "" CACHE PATH "Compile demo with TensorRT")#根据实际情况调整
  SET(FAISS_DIR "xx../faiss")#填写faiss的lib所在路径(编译后或下载的预编译解压路径)
  ...

如果使用了OpenBLAS

  22行 SET(BLAS_NAME "openblas") 修改成libopenblas.lib的实际位置，如 SET(BLAS_NAME "${PADDLE_LIB}/third_party/install/openblas/lib/libopenblas.lib")
  ...
  239行 target_link_libraries(${DEMO_NAME} ${BLAS_NAME}${CMAKE_SHARED_LIBRARY_SUFFIX}) 去掉文件后缀 target_link_libraries(${DEMO_NAME} ${BLAS_NAME})

将项目设置成Release模式， 右键pp_shitu->生成项目，即可。

如果在编译过程中遇到报错，主要是几种情况：

-CMakeLists.txt 里面的文件名与实际情况不一致，或者文件位置不一致，可以参考5.10中提供的两个例子，根据实际情况调整 CMakeLists.txt

-某些函数不能编译，确认使用的第三方库是否是Release模式，个别函数不能识别，确认头文件与Lib文件版本是否一致

-程序无法正常启动执行，主要是因为缺少第三方的动态库文件，可以根据对应的提示，将相应的文件拷贝到Release目录下。