Skip to content

Commit 8c63243

Browse files
zhang-progzhang-prog
committed
[cherry-pick] update edge deployment docs (#4126)
* update edge deployment docs * update paddle2onnx doc * update
1 parent 5c5702e commit 8c63243

File tree

6 files changed

+126
-23
lines changed

6 files changed

+126
-23
lines changed

‎docs/pipeline_deploy/edge_deploy.en.md‎

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ comments: true
1313
- [Feedback Section](#feedback-section)
1414

1515
This guide mainly introduces the operation method of the PaddleX edge deployment demo on the Android shell.
16-
This guide applies to 8 models across 6 modules:
16+
This guide applies to 13 models across 7 modules:
1717

1818
<table>
1919
<tr>
@@ -57,17 +57,43 @@ This guide applies to 8 models across 6 modules:
5757
<td>✅</td>
5858
</tr>
5959
<tr>
60-
<td>Text Detection</td>
60+
<td>Text Line Orientation Classification</td>
61+
<td>PP-LCNet_x0_25_textline_ori</td>
62+
<td>✅</td>
63+
<td>✅</td>
64+
</tr>
65+
<tr>
66+
<td rowspan="3">Text Detection</td>
67+
<td>PP-OCRv5_mobile_det</td>
68+
<td>✅</td>
69+
<td></td>
70+
</tr>
71+
<tr>
6172
<td>PP-OCRv4_mobile_det</td>
6273
<td>✅</td>
6374
<td></td>
6475
</tr>
6576
<tr>
66-
<td>Text Recognition</td>
77+
<td>PP-OCRv3_mobile_det</td>
78+
<td>✅</td>
79+
<td></td>
80+
</tr>
81+
<tr>
82+
<td rowspan="3">Text Recognition</td>
83+
<td>PP-OCRv5_mobile_rec</td>
84+
<td>✅</td>
85+
<td></td>
86+
</tr>
87+
<tr>
6788
<td>PP-OCRv4_mobile_rec</td>
6889
<td>✅</td>
6990
<td></td>
7091
</tr>
92+
<tr>
93+
<td>PP-OCRv3_mobile_rec</td>
94+
<td>✅</td>
95+
<td></td>
96+
</tr>
7197
</table>
7298

7399
<b>Note</b>
@@ -290,17 +316,38 @@ This section describes the deployment steps applicable to the demos listed in th
290316
<td>MobileNetV3_small_x1_0</br>MobileNetV3_small_x1_0_gpu</td>
291317
</tr>
292318
<tr>
293-
<td rowspan="2">General OCR</td>
294-
<td rowspan="2">ocr</td>
319+
<td rowspan="3">General OCR</td>
320+
<td rowspan="3">ocr</td>
295321
<td>Text Detection</td>
296-
<td rowspan="2">ppocr_demo</td>
297-
<td>PP-OCRv4_mobile_det</td>
298-
<td>PP-OCRv4_mobile_det</td>
322+
<td rowspan="3">ppocr_demo</td>
323+
<td>
324+
PP-OCRv5_mobile_det</br>
325+
PP-OCRv4_mobile_det</br>
326+
PP-OCRv3_mobile_det
327+
</td>
328+
<td>
329+
PP-OCRv5_mobile_det</br>
330+
PP-OCRv4_mobile_det</br>
331+
PP-OCRv3_mobile_det
332+
</td>
333+
</tr>
334+
<tr>
335+
<td>Text Line Orientation Classification</td>
336+
<td>PP-LCNet_x0_25_textline_ori</td>
337+
<td>PP-LCNet_x0_25_textline_ori</td>
299338
</tr>
300339
<tr>
301340
<td>Text Recognition</td>
302-
<td>PP-OCRv4_mobile_rec</td>
303-
<td>PP-OCRv4_mobile_rec</td>
341+
<td>
342+
PP-OCRv5_mobile_rec</br>
343+
PP-OCRv4_mobile_rec</br>
344+
PP-OCRv3_mobile_rec
345+
</td>
346+
<td>
347+
PP-OCRv5_mobile_rec</br>
348+
PP-OCRv4_mobile_rec</br>
349+
PP-OCRv3_mobile_rec
350+
</td>
304351
</tr>
305352
</table>
306353

‎docs/pipeline_deploy/edge_deploy.md‎

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ comments: true
1313
- [反馈专区](#反馈专区)
1414

1515
本指南主要介绍 PaddleX 端侧部署 demo 在 Android shell 上的运行方法。
16-
本指南适用于下列 6 种模块的 8 个模型：
16+
本指南适用于下列 7 种模块的 13 个模型：
1717

1818
<table>
1919
<tr>
@@ -57,17 +57,43 @@ comments: true
5757
<td>✅</td>
5858
</tr>
5959
<tr>
60-
<td>文本检测</td>
60+
<td>文本行方向分类</td>
61+
<td>PP-LCNet_x0_25_textline_ori</td>
62+
<td>✅</td>
63+
<td>✅</td>
64+
</tr>
65+
<tr>
66+
<td rowspan="3">文本检测</td>
67+
<td>PP-OCRv5_mobile_det</td>
68+
<td>✅</td>
69+
<td></td>
70+
</tr>
71+
<tr>
6172
<td>PP-OCRv4_mobile_det</td>
6273
<td>✅</td>
6374
<td></td>
6475
</tr>
6576
<tr>
66-
<td>文本识别</td>
77+
<td>PP-OCRv3_mobile_det</td>
78+
<td>✅</td>
79+
<td></td>
80+
</tr>
81+
<tr>
82+
<td rowspan="3">文本识别</td>
83+
<td>PP-OCRv5_mobile_rec</td>
84+
<td>✅</td>
85+
<td></td>
86+
</tr>
87+
<tr>
6788
<td>PP-OCRv4_mobile_rec</td>
6889
<td>✅</td>
6990
<td></td>
7091
</tr>
92+
<tr>
93+
<td>PP-OCRv3_mobile_rec</td>
94+
<td>✅</td>
95+
<td></td>
96+
</tr>
7197
</table>
7298

7399
<b>备注</b>
@@ -292,17 +318,38 @@ detection, image size: 768, 576, detect object: dog, score: 0.731584, location:
292318
<td>MobileNetV3_small_x1_0</br>MobileNetV3_small_x1_0_gpu</td>
293319
</tr>
294320
<tr>
295-
<td rowspan="2">通用OCR</td>
296-
<td rowspan="2">ocr</td>
321+
<td rowspan="3">通用OCR</td>
322+
<td rowspan="3">ocr</td>
297323
<td>文本检测</td>
298-
<td rowspan="2">ppocr_demo</td>
299-
<td>PP-OCRv4_mobile_det</td>
300-
<td>PP-OCRv4_mobile_det</td>
324+
<td rowspan="3">ppocr_demo</td>
325+
<td>
326+
PP-OCRv5_mobile_det</br>
327+
PP-OCRv4_mobile_det</br>
328+
PP-OCRv3_mobile_det
329+
</td>
330+
<td>
331+
PP-OCRv5_mobile_det</br>
332+
PP-OCRv4_mobile_det</br>
333+
PP-OCRv3_mobile_det
334+
</td>
335+
</tr>
336+
<tr>
337+
<td>文本行方向分类</td>
338+
<td>PP-LCNet_x0_25_textline_ori</td>
339+
<td>PP-LCNet_x0_25_textline_ori</td>
301340
</tr>
302341
<tr>
303342
<td>文本识别</td>
304-
<td>PP-OCRv4_mobile_rec</td>
305-
<td>PP-OCRv4_mobile_rec</td>
343+
<td>
344+
PP-OCRv5_mobile_rec</br>
345+
PP-OCRv4_mobile_rec</br>
346+
PP-OCRv3_mobile_rec
347+
</td>
348+
<td>
349+
PP-OCRv5_mobile_rec</br>
350+
PP-OCRv4_mobile_rec</br>
351+
PP-OCRv3_mobile_rec
352+
</td>
306353
</tr>
307354
</table>
308355

‎docs/pipeline_deploy/high_performance_inference.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,11 @@ output = model.predict("https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/
208208

209209
#### 2.1.1 安全自动配置模式
210210

211-
安全自动配置模式，具有保护机制，默认**自动选用当前环境性能较优的配置**。在这种模式下，用户可以覆盖默认配置，但用户提供的配置将受到检查，PaddleX将根据先验知识拒绝不可用的配置。这是默认的工作模式。
211+
安全自动配置模式，具有保护机制，默认 **自动选用当前环境性能较优的配置** 。在这种模式下，用户可以覆盖默认配置，但用户提供的配置将受到检查，PaddleX将根据先验知识拒绝不可用的配置。这是默认的工作模式。
212212

213213
#### 2.1.2 无限制手动配置模式
214214

215-
无限制手动配置模式，提供完全的配置自由，可以**自由选择推理后端、修改后端配置等**，但无法保证推理一定成功。此模式适合有经验和对推理后端及其配置有明确需求的用户，建议在熟悉高性能推理的情况下使用。
215+
无限制手动配置模式，提供完全的配置自由，可以 **自由选择推理后端、修改后端配置等** ，但无法保证推理一定成功。此模式适合有经验和对推理后端及其配置有明确需求的用户，建议在熟悉高性能推理的情况下使用。
216216

217217
### 2.2 高性能推理配置
218218

@@ -461,7 +461,7 @@ Predict:
461461
462462
### 2.4 在配置文件中启用/禁用高性能推理插件
463463
464-
在配置文件中，可以使用 `use_hpip` 控制高性能推理插件的启用和禁用。与通过 CLI 和 API 配置不同的是，这种方式支持通过在子产线/子模块级别使用 `use_hpip`，实现**仅产线中的某个子产线/子模块使用高性能推理**。示例如下：
464+
在配置文件中，可以使用 `use_hpip` 控制高性能推理插件的启用和禁用。与通过 CLI 和 API 配置不同的是，这种方式支持通过在子产线/子模块级别使用 `use_hpip`，实现 **仅产线中的某个子产线/子模块使用高性能推理**。示例如下：
465465

466466
**通用OCR产线的 `text_detection` 模块使用高性能推理，`text_recognition` 模块不使用高性能推理：**
467467

‎docs/pipeline_deploy/paddle2onnx.en.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ The Paddle2ONNX plugin for PaddleX provides the ability to convert PaddlePaddle
55
## 1. Installation
66

77
```bash
8+
# Windows users need to use the following command to install the dev version of paddlepaddle
9+
# python -m pip install --pre paddlepaddle -i https://www.paddlepaddle.org.cn/packages/nightly/cpu/
10+
11+
# Install Paddle2ONNX plugin
812
paddlex --install paddle2onnx
913
```
1014

‎docs/pipeline_deploy/paddle2onnx.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ PaddleX 的 Paddle2ONNX 插件提供了将飞桨静态图模型转化到 ONNX
66
## 1. 安装
77

88
```bash
9+
# Windows 用户需使用以下命令安装 paddlepaddle dev版本
10+
# python -m pip install --pre paddlepaddle -i https://www.paddlepaddle.org.cn/packages/nightly/cpu/
11+
12+
# 安装 Paddle2ONNX 插件
913
paddlex --install paddle2onnx
1014
```
1115

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,7 @@ plugins:
186186
高性能推理: High Performance Inference
187187
服务化部署: Serving
188188
端侧部署: Edge Deployment
189+
获取 ONNX 模型: Obtaining ONNX Models
189190
多硬件使用: Multi-Device Usage
190191
多硬件使用指南: Multi-Device Usage Guide
191192
飞桨多硬件安装: PaddlePaddle Installation on Multiple Devices

0 commit comments

Comments
 (0)