Add TIPC CPP Serving Doc (#5506)

* Add TIPC CPP Serving Doc * Add TIPC CPP Serving Doc * update doc

Add TIPC CPP Serving Doc (#5506)
* Add TIPC CPP Serving Doc * Add TIPC CPP Serving Doc * update doc
1690dea2 · TeslaZhao · GitHub · 8acc62e7 · 1690dea2 · 1690dea2
4 changed file
--- a/tutorials/mobilenetv3_prod/Step6/test_tipc/configs/mobilenet_v3_small/serving_infer_cpp.txt
+++ b/tutorials/mobilenetv3_prod/Step6/test_tipc/configs/mobilenet_v3_small/serving_infer_cpp.txt
+===========================serving_params===========================
+model_name:mobilenet_v3_small
+python:python3.7
+trans_model:-m paddle_serving_client.convert
+--dirname:./inference/mobilenet_v3_small_infer/
+--model_filename:inference.pdmodel
+--params_filename:inference.pdiparams
+--serving_server:./deploy/serving_python/serving_server/
+--serving_client:./deploy/serving_python/serving_client/
+serving_dir:./deploy/serving_python
+--model:./deploy/serving_python/serving_server/
+--port:9993
+cpp_client:serving_client.py
\ No newline at end of file
--- a/tutorials/mobilenetv3_prod/Step6/test_tipc/test_serving_infer_cpp.sh
+++ b/tutorials/mobilenetv3_prod/Step6/test_tipc/test_serving_infer_cpp.sh
+#!/bin/bash
+source test_tipc/common_func.sh
+
+FILENAME=$1
+dataline=$(awk 'NR==1, NR==18{print}'  $FILENAME)
+MODE=$2
+
+# parser params
+IFS=$'\n'
+lines=(${dataline})
+
+# parser serving
+model_name=$(func_parser_value "${lines[1]}")
+python_list=$(func_parser_value "${lines[2]}")
+trans_model_py=$(func_parser_value "${lines[3]}")
+infer_model_dir_key=$(func_parser_key "${lines[4]}")
+infer_model_dir_value=$(func_parser_value "${lines[4]}")
+model_filename_key=$(func_parser_key "${lines[5]}")
+model_filename_value=$(func_parser_value "${lines[5]}")
+params_filename_key=$(func_parser_key "${lines[6]}")
+params_filename_value=$(func_parser_value "${lines[6]}")
+serving_server_key=$(func_parser_key "${lines[7]}")
+serving_server_value=$(func_parser_value "${lines[7]}")
+serving_client_key=$(func_parser_key "${lines[8]}")
+serving_client_value=$(func_parser_value "${lines[8]}")
+serving_dir_value=$(func_parser_value "${lines[9]}")
+run_model_path_key=$(func_parser_value "${lines[10]}")
+run_model_path_value=$(func_parser_value "${lines[11]}")
+port_key=$(func_parser_value "${lines[12]}")
+port_value=$(func_parser_key "${lines[13]}")
+cpp_client_value=$(func_parser_value "${lines[14]}")
+
+
+LOG_PATH="./log/${model_name}/${MODE}"
+mkdir -p ${LOG_PATH}
+status_log="${LOG_PATH}/results_serving.log"
+
+function func_serving(){
+    IFS='|'
+    _python=$1
+    _script=$2
+    _model_dir=$3
+
+    # phrase 1: save model
+    set_dirname=$(func_set_params "${infer_model_dir_key}" "${infer_model_dir_value}")
+    set_model_filename=$(func_set_params "${model_filename_key}" "${model_filename_value}")
+    set_params_filename=$(func_set_params "${params_filename_key}" "${params_filename_value}")
+    set_serving_server=$(func_set_params "${serving_server_key}" "${serving_server_value}")
+    set_serving_client=$(func_set_params "${serving_client_key}" "${serving_client_value}")
+    python_list=(${python_list})
+    python=${python_list[0]}
+    trans_model_cmd="${python} ${trans_model_py} ${set_dirname} ${set_model_filename} ${set_params_filename} ${set_serving_server} ${set_serving_client}"
+    eval $trans_model_cmd}
+    cd ${serving_dir_value}
+    echo $PWD
+    unset https_proxy
+    unset http_proxy
+
+    web_service_cmd="${python} ${web_service_py} &"
+    eval $web_service_cmd
+    sleep 2s
+    _save_log_path="../../log/${model_name}/${MODE}/server_infer_gpu_batchsize_1.log"
+
+    # phrase 2: run server
+    cpp_server_cmd="${python} -m paddle_serving_server.serve ${run_model_path_key} ${run_model_path_value} ${port_key} ${port_value} > ${_save_log_path} 2>&1 "
+    eval $cpp_server_cmd
+    last_status=${PIPESTATUS[0]}
+    eval "cat ${_save_log_path}"
+    cd ../../
+    status_check $last_status "${cpp_server_cmd}" "${status_log}"
+    ps ux | grep -i 'paddle_serving_server' | awk '{print $2}' | xargs kill -s 9
+}
+
+
+# set cuda device
+GPUID=$3
+if [ ${#GPUID} -le 0 ];then
+    env=" "
+else
+    env="export CUDA_VISIBLE_DEVICES=${GPUID}"
+fi
+set CUDA_VISIBLE_DEVICES
+eval $env
+
+
+echo "################### run test ###################"
+
+export Count=0
+IFS="|"
+func_serving "${web_service_cmd}"
--- a/tutorials/tipc/serving_cpp/README.md
+++ b/tutorials/tipc/serving_cpp/README.md
@@ -9,3 +9,81 @@
 - [3. 服务化部署测试开发与规范](#3)
    - [3.1 开发流程](#3.1)
    - [3.2 核验点](#3.2)
+
+<a name="1"></a>
+
+## 1.简介
+该系列文档主要介绍 Linux GPU/CPU C++ 服务化部署开发过程，主要包含2个步骤。
+- 步骤一：参考[《Linux GPU/CPU C++ 服务化部署功能开发文档》](./serving_cpp.md)，完成Linux GPU/CPU C++ 服务化部署功能开发。
+- 步骤二：参考[《Linux GPU/CPU C++ 服务化部署功能测试开发文档》](./test_serving_cpp.md)，完成Linux GPU/CPU C++ 服务化部署功能测试开发。
+
+<a name="2"></a>
+
+## 2.服务化部署流程开发规范
+
+<a name="2.1"></a>
+
+### 2.1 开发流程
+
+Linux GPU/CPU C++ 服务化部署功能开发过程以分为下面8个步骤。
+
+<div align="center">
+    <img src="../images/serving_guide.png" width="800">
+</div>
+
+更多内容请参考：[Linux GPU/CPU C++ 服务化部署功能开发文档]()。
+
+<a name="2.2"></a>
+
+### 2.2 检验点
+
+在开发过程中，至少需要产出下面的内容。
+
+#### 2.2.1 模型服务部署成功
+
+- 成功启动模型预测服务，并在客户端完成访问，返回结果。
+
+#### 2.2.2 服务化部署结果正确性
+
+- 返回结果与基于Paddle Inference的模型推理结果完全一致。
+
+<a name="3"></a>
+
+## 3.服务化部署测试开发规范
+
+<a name="3.1"></a>
+
+### 3.1 开发规范
+
+基础训练推理测试开发的流程如下所示。
+
+<div align="center">
+    <img src="../train_infer_python/images/test_linux_train_infer_python_pipeline.png" width="400">
+</div>
+
+更多的介绍可以参考：[Linux GPU/CPU C++ 服务化部署测试开发文档]()。
+
+<a name="3.2"></a>
+
+### 3.2 核验点
+
+#### 3.2.1 目录结构
+
+在 repo 根目录下面新建 `test_tipc` 文件夹，目录结构如下所示。
+```
+test_tipc
+    |--configs                              # 配置目录
+    |    |--model_name                      # 您的模型名称
+    |           |--serving_infer_cpp.txt    # C++ 服务化部署测试配置文件
+    |--docs                                 # 文档目录
+    |   |--test_serving_infer_cpp.md        # C++ 服务化部署测试说明文档
+    |----README.md                          # TIPC说明文档
+    |----test_serving_infer_cpp.sh          # C++ 服务化部署解析脚本，无需改动
+    |----common_func.sh                     # TIPC基础训练推理测试常用函数，无需改动
+```
+
+#### 3.2.2 配置文件和测试文档
+
+- `test_tipc/README.md` 文档中对该模型支持的的功能进行总体介绍。
+- `test_tipc/docs/test_serving_infer_cpp.md` 文档中对 `Paddle Serving` 的功能支持情况进行介绍。
+- 根据测试文档，基于配置文件，跑通训练推理全流程测试。
--- a/tutorials/tipc/serving_cpp/test_serving_cpp.md
+++ b/tutorials/tipc/serving_cpp/test_serving_cpp.md
@@ -3,7 +3,270 @@
 # 目录

 - [1. 简介](#1)
- [2. 基本服务化部署功能测试开发](#2---)
- [3. 高级服务化部署功能测试开发](#3---)
+- [2. 命令与配置文件解析](#2)
+    - [2.1 命令解析](#2.1)
+    - [2.2 配置文件和运行命令映射解析](#2.2)
+- [3. 基本训练推理功能测试开发](#3)
+    - [2.1 准备待测试的命令](#3.1)
+    - [2.2 准备数据与环境](#3.2)
+    - [2.3 准备开发所需脚本](#3.3)
+    - [2.4 填写配置文件](#3.4)
+    - [2.5 验证配置正确性](#3.5)
+    - [2.6 撰写说明文档](#3.6)
 - [4. FAQ](#4)

+<a name="1"></a>
+
+# 1.简介
+
+Paddle Serving 是飞桨官方推荐的服务化推理框架，长期目标就是为人工智能落地的最后一公里提供专业、可靠且易用的在线服务。
+
+本文档主要关注Linux GPU/CPU 下模型的C++ 服务化部署功能测试，具体测试点如下：
+- 模型转换：部署模型转换跑通
+- 模型部署：C++服务部署过程跑通
+
+为了一键跑通上述所有功能，本文档提供了`训推一体全流程`功能自动化测试工具，它包含3个脚本文件和1个配置文件，分别是：
+- `test_serving_infer_cpp.sh`：测试部署模型转换和python服务部署预测的脚本，会对 `serving_infer_cpp.txt` 进行解析，得到具体的执行命令。**该脚本无需修改**。
+- `prepare.sh`：准备测试需要的数据或需要的预训练模型。
+- `common_func.sh`：在配置文件一些通用的函数，如配置文件的解析函数等，**该脚本无需修改**。
+- `serving_infer_cpp.txt`：配置文件，其中的内容会被 `test_serving_infer_cpp.sh` 解析成具体的执行命令字段。
+
+<a name="2"></a>
+
+# 2.命令与配置文件解析
+
+<a name="2.1"></a>
+
+## 2.1 命令解析
+
+Paddle Serving 的 C++ 服务的客户端启动命令一般由 PYTHON 程序编写，可以拆解为2个部分：
+
+```
+python run_script
+```
+例如：
+- 对于通过argparse传参的场景来说，`python3 resnet50_client.py`
+- `python`：替换为 `python3.7`
+- `run_script`：替换为 `resnet50_client.py`
+
+<a name="2.2"></a>
+
+## 2.2 配置文件和运行命令映射解析
+完整的 `serving_infer_cpp.txt` 配置文件共有13行，包含2个方面的内容。
+- Serving 部署模型转换：第4~10行
+- Serving 启动部署服务：第10~13行
+
+具体内容见 `serving_infer_cpp.txt`。
+
+配置文件中主要有以下3种类型的字段。
+- 一行内容以冒号为分隔符：该行可以被解析为 `key:value` 的格式，需要根据实际的含义修改该行内容，下面进行详细说明。
+- 一行内容为 `======xxxxx=====`：该行内容为注释信息，无需修改。
+- 一行内容为 `##`：该行内容表示段落分隔符，没有实际意义，无需修改。
+
+### 2.2.1 模型转换配置参数
+
+在配置文件中，可以通过下面的方式配置一些常用的超参数，如：Paddle模型路径、部署模型路径等，下面给出了常用的训练配置以及需要修改的内容。
+
+<details>
+<summary>模型转换配置参数（点击以展开详细内容或者折叠）</summary>
+
+| 行号 | 参考内容                                | 含义            | key是否需要修改 | value是否需要修改 | 修改内容                             |
+|----|-------------------------------------|---------------|-----------|-------------|----------------------------------|
+| 2  | model_name:mobilenet_v3_small      | 模型名字          | 否         | 是           | value修改为自己的模型名字                  |
+| 3  | python:python3.7                    | python环境      | 否         | 是           | value修改为自己的python环境              |
+| 5  | --dirname:./inference/mobilenet_v3_small_infer/ | Paddle inference 模型保存路径 | 否        | 是           | value修改为自己 Inference 模型的路径                  |
+| 6  | --model_filename:inference.pdmodel  | pdmodel 文件名     | 否     | 是           | value修改为 pdmodel 文件名           |
+| 7  | --params_filename:inference.pdiparams     | pdiparams 文件名 | 否        | 是       | value修改为 pdiparams 文件名       |
+| 8  | --serving_server:./deploy/serving_cpp/serving_server/ | 转换出的部署模型目录 | 否       | 是           | value修改为部署模型模型保存路径      |
+| 9  | --serving_client:./deploy/serving_cpp/serving_client/ | 转换出的服务模型目录 | 否       | 是           | value修改为服务模型保存路径      |
+
+</details>
+
+以模型转换命令为例，总共包含5个超参数。
+```python
+python3.7 -m paddle_serving_client.convert --dirname=./inference/resnet50_infer/ --model_filename=inference.pdmodel --params_filename=inference.pdiparams --serving_server=./deploy/serving_cpp/serving_server/ --serving_client=./deploy/serving_cpp/serving_client/
+```
+
+- 推理模型路径：`--dirname=./inference/resnet50_infer/`，则需要修改第5行
+- pdmodel文件名：`--model_filename=inference.pdmodel`，则需要修改第6行
+- 其他参数以此类推
+
+### 2.2.2 C++ 服务部署配置参数
+
+C++ 服务的客户端采用 PYTHON 语言编写。
+```python
+python3.7 serving_client.py
+```
+
+<a name="3"></a>
+
+# 3. C++ 服务化部署功能测试开发
+
+服务化部署功能测试开发主要分为以下6个步骤。
+
+<div align="center">
+    <img src="https://raw.githubusercontent.com/PaddlePaddle/models/release/2.2/tutorials/tipc/train_infer_python/images/test_linux_train_infer_python_pipeline.png" width="800">
+</div>
+
+
+其中设置了2个核验点，下面详细介绍开发过程。
+
+<a name="3.1"></a>
+
+## 3.1 准备待测试的命令
+
+**【基本内容】**
+
+准备模型转换、模型推理的命令，后续会将这些命令按照[第2节](#2)所述内容，映射到配置文件中。
+
+**【实战】**
+
+MobileNetV3 的 Serving模型转换、服务部署运行命令如下所示：
+
+```python
+# 模型转换
+python3.7 -m paddle_serving_client.convert
+--dirnam=./inference/mobilenet_v3_small_infer/ \
+--model_filename=inference.pdmodel \
+--params_filename=inference.pdiparams \
+--serving_server=./deploy/serving_cpp/serving_server/ \
+--serving_client=./deploy/serving_cpp/serving_client/
+
+# 部署
+python3.7 -m paddle_serving_server.serve --model ./deploy/serving_cpp/serving_server/ --port 9993
+python3.7 serving_client.py
+```
+
+<a name="3.2"></a>
+
+## 3.2 准备数据与环境
+
+**【基本内容】**
+
+1. 数据集：为方便快速验证训练/评估/推理过程，需要准备一个小数据集（训练集和验证集各8~16张图像即可，压缩后数据大小建议在`20M`以内），放在`lite_data`文件夹下。
+
+    相关文档可以参考[论文复现赛指南3.2章节](../../../docs/lwfx/ArticleReproduction_CV.md)，代码可以参考`基于ImageNet准备小数据集的脚本`：[prepare.py](https://github.com/littletomatodonkey/AlexNet-Prod/blob/tipc/pipeline/Step2/prepare.py)。
+
+2. 环境：安装好PaddlePaddle即可进行离线量化训练推理测试开发
+
+**【注意事项】**
+
+* 为方便管理，建议在上传至github前，首先将lite_data文件夹压缩为tar包，直接上传tar包即可，在测试训练评估与推理过程时，可以首先对数据进行解压。
+    * 压缩命令： `tar -zcf lite_data.tar lite_data`
+    * 解压命令： `tar -xf lite_data.tar`
+
+<a name="3.3"></a>
+
+## 3.3 准备开发所需脚本
+
+**【基本内容】**
+
+在repo中新建`test_tipc`目录，将文件 [common_func.sh](../../mobilenetv3_prod/Step6/test_tipc/common_func.sh) ， [prepare.sh](../../mobilenetv3_prod/Step6/test_tipc/prepare.sh) 和 [test_serving_infer_cpp.sh](../../mobilenetv3_prod/Step6/test_tipc/test_serving_infer_cpp.sh) 分别拷贝到`test_tipc`目录中。
+
+
+**【注意事项】**
+
+* 上述3个脚本文件无需改动，在实际使用时，直接修改配置文件即可。
+
+<a name="3.4"></a>
+
+## 3.4 填写配置文件
+
+**【基本内容】**
+
+在repo的`test_tipc/`目录中新建`configs/model_name`，将文件 [serving_infer_cpp.txt](../../mobilenetv3_prod/Step6/test_tipc/configs/mobilenet_v3_small/serving_infer_cpp.txt) 拷贝到该目录中，其中`model_name`需要修改为您自己的模型名称。
+
+**【实战】**
+
+配置文件的含义解析可以参考 [2.2节配置文件解析](#2.2) 部分。
+
+mobilenet_v3_small的测试开发配置文件可以参考：[serving_infer_cpp.txt](../../mobilenetv3_prod/Step6/test_tipc/configs/mobilenet_v3_small/serving_infer_cpp.txt)。
+
+<a name="3.5"></a>
+
+### 3.5 验证配置正确性
+
+**【基本内容】**
+
+基于修改完的配置，运行
+
+```bash
+bash test_tipc/prepare.sh ${your_params_file} serving_infer
+bash test_tipc/test_serving_infer_cpp.sh ${your_params_file} serving_infer
+```
+
+**【注意事项】**
+
+如果运行失败，会输出具体的报错命令，可以根据输出的报错命令排查下配置文件的问题并修改，示例报错如下所示。
+
+```
+Run failed with command - python3.7 serving_client.py > ../../log/mobilenet_v3_small/serving_infer/server_infer_batchsize_1.log 2>&1 !
+```
+
+**【实战】**
+
+以mobilenet_v3_small的`Linux GPU/CPU 离线量化训练推理功能测试` 为例，命令如下所示。
+
+```bash
+bash test_tipc/test_serving_infer_cpp.sh test_tipc/configs/mobilenet_v3_small/serving_infer_cpp.txt serving_infer
+```
+
+输出结果如下，表示命令运行成功。
+
+```bash
+Run successfully with command - python3.7 serving_client.py > ../../log/mobilenet_v3_small/serving_infer/server_infer_batchsize_1.log 2>&1 !
+```
+
+**【核验】**
+
+基于修改后的配置文件，测试通过，全部命令成功
+
+<a name="3.6"></a>
+
+### 3.6 撰写说明文档
+
+**【基本内容】**
+
+撰写TIPC功能总览和测试流程说明文档，分别为
+
+1. TIPC功能总览文档：test_tipc/README.md
+2. Linux GPU/CPU 离线量化训练推理功能测试说明文档：test_tipc/docs/test_serving_infer_cpp.md
+
+2个文档模板分别位于下述位置，可以直接拷贝到自己的repo中，根据自己的模型进行修改。
+
+1. [README.md](../../mobilenetv3_prod/Step6/test_tipc/README.md)
+2. [test_serving_infer_cpp.md](../../mobilenetv3_prod/Step6/test_tipc/docs/test_serving_infer_cpp.md)
+
+**【实战】**
+
+mobilenet_v3_small中`test_tipc`文档如下所示。
+
+1. TIPC功能总览文档：[README.md](../../mobilenetv3_prod/Step6/test_tipc/README.md)
+2. Python Serving 测试说明文档：[test_serving_infer_cpp.md](../../mobilenetv3_prod/Step6/test_tipc/docs/test_serving_infer_cpp.md)
+
+**【核验】**
+
+repo中最终目录结构如下所示。
+
+```
+test_tipc
+    |--configs                              # 配置目录
+    |    |--model_name                      # 您的模型名称
+    |           |--serving_infer_cpp.txt    # C++ 服务化部署测试配置文件
+    |--docs                                 # 文档目录
+    |   |--test_serving_infer_cpp.md        # C++ 服务化部署测试说明文档
+    |----README.md                          # TIPC说明文档
+    |----test_serving_infer_cpp.sh          # C++ 服务化部署解析脚本，无需改动
+    |----common_func.sh                     # TIPC基础训练推理测试常用函数，无需改动
+```
+
+基于`test_serving_infer_cpp.md`文档，跑通 `C++服务化部署功能测试` 流程。
+
+<a name="4"></a>
+
+## 4. FAQ
+
+```
+unset http_proxy
+unset https_proxy
+```