Browse Source

update edge deployment docs (#4126)

* update edge deployment docs

* update paddle2onnx doc

* update
zhang-prog 5 months ago
parent
commit
f0f9c58913

+ 57 - 10
docs/pipeline_deploy/edge_deploy.en.md

@@ -13,7 +13,7 @@ comments: true
   - [Feedback Section](#feedback-section)
   - [Feedback Section](#feedback-section)
 
 
 This guide mainly introduces the operation method of the PaddleX edge deployment demo on the Android shell.
 This guide mainly introduces the operation method of the PaddleX edge deployment demo on the Android shell.
-This guide applies to 8 models across 6 modules:
+This guide applies to 13 models across 7 modules:
 
 
 <table>
 <table>
   <tr>
   <tr>
@@ -57,17 +57,43 @@ This guide applies to 8 models across 6 modules:
     <td>✅</td>
     <td>✅</td>
   </tr>
   </tr>
   <tr>
   <tr>
-    <td>Text Detection</td>
+    <td>Text Line Orientation Classification</td>
+    <td>PP-LCNet_x0_25_textline_ori</td>
+    <td>✅</td>
+    <td>✅</td>
+  </tr>
+  <tr>
+    <td rowspan="3">Text Detection</td>
+    <td>PP-OCRv5_mobile_det</td>
+    <td>✅</td>
+    <td></td>
+  </tr>
+  <tr>
     <td>PP-OCRv4_mobile_det</td>
     <td>PP-OCRv4_mobile_det</td>
     <td>✅</td>
     <td>✅</td>
     <td></td>
     <td></td>
   </tr>
   </tr>
   <tr>
   <tr>
-    <td>Text Recognition</td>
+    <td>PP-OCRv3_mobile_det</td>
+    <td>✅</td>
+    <td></td>
+  </tr>
+  <tr>
+    <td rowspan="3">Text Recognition</td>
+    <td>PP-OCRv5_mobile_rec</td>
+    <td>✅</td>
+    <td></td>
+  </tr>
+  <tr>
     <td>PP-OCRv4_mobile_rec</td>
     <td>PP-OCRv4_mobile_rec</td>
     <td>✅</td>
     <td>✅</td>
     <td></td>
     <td></td>
   </tr>
   </tr>
+  <tr>
+    <td>PP-OCRv3_mobile_rec</td>
+    <td>✅</td>
+    <td></td>
+  </tr>
 </table>
 </table>
 
 
 <b>Note</b>
 <b>Note</b>
@@ -290,17 +316,38 @@ This section describes the deployment steps applicable to the demos listed in th
     <td>MobileNetV3_small_x1_0</br>MobileNetV3_small_x1_0_gpu</td>
     <td>MobileNetV3_small_x1_0</br>MobileNetV3_small_x1_0_gpu</td>
   </tr>
   </tr>
   <tr>
   <tr>
-    <td rowspan="2">General OCR</td>
-    <td rowspan="2">ocr</td>
+    <td rowspan="3">General OCR</td>
+    <td rowspan="3">ocr</td>
     <td>Text Detection</td>
     <td>Text Detection</td>
-    <td rowspan="2">ppocr_demo</td>
-    <td>PP-OCRv4_mobile_det</td>
-    <td>PP-OCRv4_mobile_det</td>
+    <td rowspan="3">ppocr_demo</td>
+    <td>
+      PP-OCRv5_mobile_det</br>
+      PP-OCRv4_mobile_det</br>
+      PP-OCRv3_mobile_det
+    </td>
+    <td>
+      PP-OCRv5_mobile_det</br>
+      PP-OCRv4_mobile_det</br>
+      PP-OCRv3_mobile_det
+    </td>
+  </tr>
+  <tr>
+    <td>Text Line Orientation Classification</td>
+    <td>PP-LCNet_x0_25_textline_ori</td>
+    <td>PP-LCNet_x0_25_textline_ori</td>
   </tr>
   </tr>
   <tr>
   <tr>
     <td>Text Recognition</td>
     <td>Text Recognition</td>
-    <td>PP-OCRv4_mobile_rec</td>
-    <td>PP-OCRv4_mobile_rec</td>
+    <td>
+      PP-OCRv5_mobile_rec</br>
+      PP-OCRv4_mobile_rec</br>
+      PP-OCRv3_mobile_rec
+    </td>
+    <td>
+      PP-OCRv5_mobile_rec</br>
+      PP-OCRv4_mobile_rec</br>
+      PP-OCRv3_mobile_rec
+    </td>
   </tr>
   </tr>
 </table>
 </table>
 
 

+ 57 - 10
docs/pipeline_deploy/edge_deploy.md

@@ -13,7 +13,7 @@ comments: true
   - [反馈专区](#反馈专区)
   - [反馈专区](#反馈专区)
 
 
 本指南主要介绍 PaddleX 端侧部署 demo 在 Android shell 上的运行方法。
 本指南主要介绍 PaddleX 端侧部署 demo 在 Android shell 上的运行方法。
-本指南适用于下列 6 种模块的 8 个模型:
+本指南适用于下列 7 种模块的 13 个模型:
 
 
 <table>
 <table>
   <tr>
   <tr>
@@ -57,17 +57,43 @@ comments: true
     <td>✅</td>
     <td>✅</td>
   </tr>
   </tr>
   <tr>
   <tr>
-    <td>文本检测</td>
+    <td>文本行方向分类</td>
+    <td>PP-LCNet_x0_25_textline_ori</td>
+    <td>✅</td>
+    <td>✅</td>
+  </tr>
+  <tr>
+    <td rowspan="3">文本检测</td>
+    <td>PP-OCRv5_mobile_det</td>
+    <td>✅</td>
+    <td></td>
+  </tr>
+  <tr>
     <td>PP-OCRv4_mobile_det</td>
     <td>PP-OCRv4_mobile_det</td>
     <td>✅</td>
     <td>✅</td>
     <td></td>
     <td></td>
   </tr>
   </tr>
   <tr>
   <tr>
-    <td>文本识别</td>
+    <td>PP-OCRv3_mobile_det</td>
+    <td>✅</td>
+    <td></td>
+  </tr>
+  <tr>
+    <td rowspan="3">文本识别</td>
+    <td>PP-OCRv5_mobile_rec</td>
+    <td>✅</td>
+    <td></td>
+  </tr>
+  <tr>
     <td>PP-OCRv4_mobile_rec</td>
     <td>PP-OCRv4_mobile_rec</td>
     <td>✅</td>
     <td>✅</td>
     <td></td>
     <td></td>
   </tr>
   </tr>
+  <tr>
+    <td>PP-OCRv3_mobile_rec</td>
+    <td>✅</td>
+    <td></td>
+  </tr>
 </table>
 </table>
 
 
 <b>备注</b>
 <b>备注</b>
@@ -292,17 +318,38 @@ detection, image size: 768, 576, detect object: dog, score: 0.731584, location:
     <td>MobileNetV3_small_x1_0</br>MobileNetV3_small_x1_0_gpu</td>
     <td>MobileNetV3_small_x1_0</br>MobileNetV3_small_x1_0_gpu</td>
   </tr>
   </tr>
   <tr>
   <tr>
-    <td rowspan="2">通用OCR</td>
-    <td rowspan="2">ocr</td>
+    <td rowspan="3">通用OCR</td>
+    <td rowspan="3">ocr</td>
     <td>文本检测</td>
     <td>文本检测</td>
-    <td rowspan="2">ppocr_demo</td>
-    <td>PP-OCRv4_mobile_det</td>
-    <td>PP-OCRv4_mobile_det</td>
+    <td rowspan="3">ppocr_demo</td>
+    <td>
+      PP-OCRv5_mobile_det</br>
+      PP-OCRv4_mobile_det</br>
+      PP-OCRv3_mobile_det
+    </td>
+    <td>
+      PP-OCRv5_mobile_det</br>
+      PP-OCRv4_mobile_det</br>
+      PP-OCRv3_mobile_det
+    </td>
+  </tr>
+  <tr>
+    <td>文本行方向分类</td>
+    <td>PP-LCNet_x0_25_textline_ori</td>
+    <td>PP-LCNet_x0_25_textline_ori</td>
   </tr>
   </tr>
   <tr>
   <tr>
     <td>文本识别</td>
     <td>文本识别</td>
-    <td>PP-OCRv4_mobile_rec</td>
-    <td>PP-OCRv4_mobile_rec</td>
+    <td>
+      PP-OCRv5_mobile_rec</br>
+      PP-OCRv4_mobile_rec</br>
+      PP-OCRv3_mobile_rec
+    </td>
+    <td>
+      PP-OCRv5_mobile_rec</br>
+      PP-OCRv4_mobile_rec</br>
+      PP-OCRv3_mobile_rec
+    </td>
   </tr>
   </tr>
 </table>
 </table>
 
 

+ 3 - 3
docs/pipeline_deploy/high_performance_inference.md

@@ -208,11 +208,11 @@ output = model.predict("https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/
 
 
 #### 2.1.1 安全自动配置模式
 #### 2.1.1 安全自动配置模式
 
 
-安全自动配置模式,具有保护机制,默认**自动选用当前环境性能较优的配置**。在这种模式下,用户可以覆盖默认配置,但用户提供的配置将受到检查,PaddleX将根据先验知识拒绝不可用的配置。这是默认的工作模式。
+安全自动配置模式,具有保护机制,默认 **自动选用当前环境性能较优的配置** 。在这种模式下,用户可以覆盖默认配置,但用户提供的配置将受到检查,PaddleX将根据先验知识拒绝不可用的配置。这是默认的工作模式。
 
 
 #### 2.1.2 无限制手动配置模式
 #### 2.1.2 无限制手动配置模式
 
 
-无限制手动配置模式,提供完全的配置自由,可以**自由选择推理后端、修改后端配置等**,但无法保证推理一定成功。此模式适合有经验和对推理后端及其配置有明确需求的用户,建议在熟悉高性能推理的情况下使用。
+无限制手动配置模式,提供完全的配置自由,可以 **自由选择推理后端、修改后端配置等** ,但无法保证推理一定成功。此模式适合有经验和对推理后端及其配置有明确需求的用户,建议在熟悉高性能推理的情况下使用。
 
 
 ### 2.2 高性能推理配置
 ### 2.2 高性能推理配置
 
 
@@ -461,7 +461,7 @@ Predict:
 
 
 ### 2.4 在配置文件中启用/禁用高性能推理插件
 ### 2.4 在配置文件中启用/禁用高性能推理插件
 
 
-在配置文件中,可以使用 `use_hpip` 控制高性能推理插件的启用和禁用。与通过 CLI 和 API 配置不同的是,这种方式支持通过在子产线/子模块级别使用 `use_hpip`,实现**仅产线中的某个子产线/子模块使用高性能推理**。示例如下:
+在配置文件中,可以使用 `use_hpip` 控制高性能推理插件的启用和禁用。与通过 CLI 和 API 配置不同的是,这种方式支持通过在子产线/子模块级别使用 `use_hpip`,实现 **仅产线中的某个子产线/子模块使用高性能推理**。示例如下:
 
 
 **通用OCR产线的 `text_detection` 模块使用高性能推理,`text_recognition` 模块不使用高性能推理:**
 **通用OCR产线的 `text_detection` 模块使用高性能推理,`text_recognition` 模块不使用高性能推理:**
 
 

+ 4 - 0
docs/pipeline_deploy/paddle2onnx.en.md

@@ -5,6 +5,10 @@ The Paddle2ONNX plugin for PaddleX provides the ability to convert PaddlePaddle
 ## 1. Installation
 ## 1. Installation
 
 
 ```bash
 ```bash
+# Windows users need to use the following command to install the dev version of paddlepaddle
+# python -m pip install --pre paddlepaddle -i https://www.paddlepaddle.org.cn/packages/nightly/cpu/
+
+# Install Paddle2ONNX plugin
 paddlex --install paddle2onnx
 paddlex --install paddle2onnx
 ```
 ```
 
 

+ 4 - 0
docs/pipeline_deploy/paddle2onnx.md

@@ -6,6 +6,10 @@ PaddleX 的 Paddle2ONNX 插件提供了将飞桨静态图模型转化到 ONNX 
 ## 1. 安装
 ## 1. 安装
 
 
 ```bash
 ```bash
+# Windows 用户需使用以下命令安装 paddlepaddle dev版本
+# python -m pip install --pre paddlepaddle -i https://www.paddlepaddle.org.cn/packages/nightly/cpu/
+
+# 安装 Paddle2ONNX 插件
 paddlex --install paddle2onnx
 paddlex --install paddle2onnx
 ```
 ```
 
 

+ 1 - 0
mkdocs.yml

@@ -186,6 +186,7 @@ plugins:
             高性能推理: High Performance Inference
             高性能推理: High Performance Inference
             服务化部署: Serving
             服务化部署: Serving
             端侧部署: Edge Deployment
             端侧部署: Edge Deployment
+            获取 ONNX 模型: Obtaining ONNX Models
             多硬件使用: Multi-Device Usage
             多硬件使用: Multi-Device Usage
             多硬件使用指南: Multi-Device Usage Guide
             多硬件使用指南: Multi-Device Usage Guide
             飞桨多硬件安装: PaddlePaddle Installation on Multiple Devices
             飞桨多硬件安装: PaddlePaddle Installation on Multiple Devices