Explorar o código

update new docs hyperlink (#2261)

cuicheng01 hai 1 ano
pai
achega
d1dc0ac9ca

+ 23 - 16
README.md

@@ -5,7 +5,7 @@
 <p align="center">
     <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Apache%202-red.svg"></a>
     <a href=""><img src="https://img.shields.io/badge/Python-3.8%2C%203.9%2C%203.10-blue.svg"></a>
-    <a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Windows-orange.svg"></a>
+    <a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Windows%2C%20Mac-orange.svg"></a>
     <a href=""><img src="https://img.shields.io/badge/Hardware-CPU%2C%20GPU%2C%20XPU%2C%20NPU%2C%20MLU%2C%20DCU-yellow.svg"></a>
 </p>
 
@@ -204,23 +204,33 @@ PaddleX的各个产线均支持本地**快速推理**,部分模型支持**在
         <td>🚧</td>
     </tr>
     <tr>
-        <td>公式识别</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
+        <td>通用版面解析</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
     </tr>
     <tr>
-        <td>印章识别</td>
+        <td>公式识别</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+    </tr>
+    <tr>
+        <td>印章识别</td>
         <td>🚧</td>
+        <td>✅</td>
+        <td>✅</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
     </tr>
     <tr>
@@ -263,16 +273,6 @@ PaddleX的各个产线均支持本地**快速推理**,部分模型支持**在
         <td>🚧</td>
         <td>🚧</td>
     </tr>
-    <tr>
-        <td>版面解析</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-    </tr>
 
     
 </table>
@@ -447,6 +447,9 @@ paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddle
 | 图像异常检测       | `paddlex --pipeline anomaly_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/uad_grid.png --device gpu:0 `                                              |
 | 通用OCR            | `paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_002.png --device gpu:0`                                                      |
 | 通用表格识别       | `paddlex --pipeline table_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg --device gpu:0`                                      |
+| 通用版面解析       | `paddlex --pipeline layout_parsing --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/demo_paper.png --device gpu:0`                                      |
+| 公式识别       | `paddlex --pipeline formula_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/demo_image/general_formula_recognition.png --device gpu:0`                                      |
+| 印章识别       | `paddlex --pipeline seal_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/seal_text_det.png --device gpu:0`                                      |
 | 时序预测       | `paddlex --pipeline ts_fc --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_fc.csv --device gpu:0`                                                                   |
 | 时序异常检测   | `paddlex --pipeline ts_ad --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_ad.csv --device gpu:0`                                                                    |
 | 时序分类       | `paddlex --pipeline ts_cls --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_cls.csv --device gpu:0`                                                                 |
@@ -488,6 +491,9 @@ for res in output:
 | 图像异常检测       | `anomaly_detection`                | [图像异常检测产线Python脚本使用说明](./docs/pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection.md#22-python脚本方式集成)                              |
 | 通用OCR            | `OCR`                              | [通用OCR产线Python脚本使用说明](./docs/pipeline_usage/tutorials/ocr_pipelines/OCR.md#222-python脚本方式集成)                                                     |
 | 通用表格识别       | `table_recognition`                | [通用表格识别产线Python脚本使用说明](./docs/pipeline_usage/tutorials/ocr_pipelines/table_recognition.md#22-python脚本方式集成)                                   |
+| 通用版面解析       | `layout_parsing`                | [通用版面解析产线Python脚本使用说明](./docs/pipeline_usage/tutorials/ocr_pipelines/layout_parsing.md#22-python脚本方式集成)                                   |
+| 公式识别       | `formula_recognition`                | [公式识别产线Python脚本使用说明](./docs/pipeline_usage/tutorials/ocr_pipelines/formula_recognition.md#22-python脚本方式集成)                                   |
+| 印章识别       | `seal_recognition`                | [印章识别产线Python脚本使用说明](./docs/pipeline_usage/tutorials/ocr_pipelines/seal_recognition.md#22-python脚本方式集成)                                   |
 | 时序预测       | `ts_fc`                            | [通用时序预测产线Python脚本使用说明](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_forecasting.md#222-python脚本方式集成)                    |
 | 时序异常检测   | `ts_ad`                            | [通用时序异常检测产线Python脚本使用说明](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection.md#222-python脚本方式集成)          |
 | 时序分类       | `ts_cls`                           | [通用时序分类产线Python脚本使用说明](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_classification.md#222-python脚本方式集成)                 |
@@ -521,6 +527,7 @@ for res in output:
 
     * [📜 通用 OCR 产线使用教程](./docs/pipeline_usage/tutorials/ocr_pipelines/OCR.md)
     * [📊 通用表格识别产线使用教程](./docs/pipeline_usage/tutorials/ocr_pipelines/table_recognition.md)
+    * [📄 通用版面解析产线使用教程](./docs/pipeline_usage/tutorials/ocr_pipelines/layout_parsing.md)
     * [📐 公式识别产线使用教程](./docs/pipeline_usage/tutorials/ocr_pipelines/formula_recognition.md)
     * [📝 印章识别产线使用教程](./docs/pipeline_usage/tutorials/ocr_pipelines/seal_recognition.md)
   </details>

+ 41 - 34
README_en.md

@@ -5,7 +5,7 @@
 <p align="center">
     <a href="./LICENSE"><img src="https://img.shields.io/badge/License-Apache%202-red.svg"></a>
     <a href=""><img src="https://img.shields.io/badge/Python-3.8%2C%203.9%2C%203.10-blue.svg"></a>
-    <a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Windows-orange.svg"></a>
+    <a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Windows%2C%20Mac-orange.svg"></a>
     <a href=""><img src="https://img.shields.io/badge/hardware-CPU%2C%20GPU%2C%20XPU%2C%20NPU%2C%20MLU%2C%20DCU-yellow.svg"></a>
 </p>
 
@@ -69,7 +69,7 @@ In addition, PaddleX provides developers with a full-process efficient model tra
         <th>Service-Oriented Deployment</th>
         <th>Edge Deployment</th>
         <th>Custom Development</th>
-        <th><a href="https://aistudio.baidu.com/pipeline/mine">No-Code Development On AI Studio</a></td> 
+        <th><a href="https://aistudio.baidu.com/pipeline/mine">Zero-Code Development On AI Studio</a></td> 
     </tr>
     <tr>
         <td>OCR</td>
@@ -202,23 +202,33 @@ In addition, PaddleX provides developers with a full-process efficient model tra
         <td>🚧</td>
     </tr>
     <tr>
-        <td>Formula Recognition</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
+        <td>Layout Parsing</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
     </tr>
     <tr>
-        <td>Seal Recognition</td>
+        <td>Formula Recognition</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
+    </tr>
+    <tr>
+        <td>Seal Recognition</td>
         <td>🚧</td>
+        <td>✅</td>
+        <td>✅</td>
+        <td>✅</td>
         <td>🚧</td>
+        <td>✅</td>
         <td>🚧</td>
     </tr>
     <tr>
@@ -261,16 +271,6 @@ In addition, PaddleX provides developers with a full-process efficient model tra
         <td>🚧</td>
         <td>🚧</td>
     </tr>
-    <tr>
-        <td>Layout Parsing</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-        <td>🚧</td>
-    </tr>
 </table>
 
 > ❗Note: The above capabilities are implemented based on GPU/CPU. PaddleX can also perform local inference and custom development on mainstream hardware such as Kunlunxin, Ascend, Cambricon, and Haiguang. The table below details the support status of the pipelines. For specific supported model lists, please refer to the [Model List (Kunlunxin XPU)](./docs/support_list/model_list_xpu_en.md)/[Model List (Ascend NPU)](./docs/support_list/model_list_npu_en.md)/[Model List (Cambricon MLU)](./docs/support_list/model_list_mlu_en.md)/[Model List (Haiguang DCU)](./docs/support_list/model_list_dcu_en.md). We are continuously adapting more models and promoting the implementation of high-performance and service-oriented deployment on mainstream hardware.
@@ -444,6 +444,9 @@ To use the command line for other pipelines, simply adjust the `pipeline` parame
 | Image Anomaly Detection      | `paddlex --pipeline anomaly_detection --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/uad_grid.png --device gpu:0 `                                              |
 | OCR                  | `paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_002.png --device gpu:0`                                                      |
 | Table Recognition    | `paddlex --pipeline table_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/table_recognition.jpg --device gpu:0`                                      |
+| Layout Parsing       | `paddlex --pipeline layout_parsing --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/demo_paper.png --device gpu:0`                                      |
+| Formula Recognition       | `paddlex --pipeline formula_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/demo_image/general_formula_recognition.png --device gpu:0`                                      |
+| Seal Recognition       | `paddlex --pipeline seal_recognition --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/seal_text_det.png --device gpu:0`                                      |
 | Time Series Forecasting | `paddlex --pipeline ts_fc --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_fc.csv --device gpu:0`                                                                   |
 | Time Series Anomaly Detection | `paddlex --pipeline ts_ad --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_ad.csv --device gpu:0`                                                                    |
 | Time Series Classification | `paddlex --pipeline ts_cls --input https://paddle-model-ecology.bj.bcebos.com/paddlex/ts/demo_ts/ts_cls.csv --device gpu:0`                                                                 |
@@ -485,7 +488,10 @@ For other pipelines in Python scripts, just adjust the `pipeline` parameter of t
 | Small Object Detection         | `small_object_detection` | [Small Object Detection Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/cv_pipelines/small_object_detection_en.md) |
 | Image Anomaly Detection       | `image_classification` | [Image Anomaly Detection Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection_en.md) |
 |  OCR            | `OCR` | [ OCR Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/ocr_pipelines/OCR_en.md) |
-|  Table Recognition       | `table_recognition` | [ Form Recognition Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/ocr_pipelines/table_recognition_en.md) |
+|  Table Recognition       | `table_recognition` | [Table Recognition Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/ocr_pipelines/table_recognition_en.md) |
+| Layout Parsing       | `layout_parsing`                | [Layout Parsing Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/ocr_pipelines/layout_parsing_en.md)                                   |
+| Formula Recognition       | `formula_recognition`                | [Formula Recognition Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/ocr_pipelines/formula_recognition_en.md)                                   |
+| Seal Recognition       | `seal_recognition`                | [Seal Recognition Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/ocr_pipelines/seal_recognition_en.md)                 |
 |  Time Series Forecast       | `ts_forecast` | [ Time Series Forecast Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_forecasting_en.md) |
 |  Time Series Anomaly Detection   | `ts_anomaly_detection` | [ Time Series Anomaly Detection Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection_en.md) |
 |  Time Series Classification       | `ts_cls` | [ Time Series Classification Pipeline Python Script Usage Instructions](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_classification_en.md) |
@@ -503,41 +509,42 @@ For other pipelines in Python scripts, just adjust the `pipeline` parameter of t
 <details open>
 <summary> <b> 🔥 Pipeline Usage </b></summary>
 
-* [📑 PaddleX pipeline Usage Overview](./docs/pipeline_usage/pipeline_develop_guide_en.md)
+* [📑 PaddleX Pipeline Usage Overview](./docs/pipeline_usage/pipeline_develop_guide_en.md)
 
 * <details open>
     <summary> <b> 📝 Information Extracion</b></summary>
 
-   * [📄 PP-ChatOCRv3 pipeline Tutorial](./docs/pipeline_usage/tutorials/information_extration_pipelines/document_scene_information_extraction_en.md)
+   * [📄 PP-ChatOCRv3 Pipeline Tutorial](./docs/pipeline_usage/tutorials/information_extration_pipelines/document_scene_information_extraction_en.md)
   </details>
 
 * <details open>
     <summary> <b> 🔍 OCR </b></summary>
 
-    * [📜 OCR pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/OCR_en.md)
-    * [📊 Table Recognition pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/table_recognition_en.md)
-    * [📐 Formula Recognition pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/formula_recognition_en.md)
-    * [📝 Seal Recognition pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/seal_recognition_en.md)
+    * [📜 OCR Pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/OCR_en.md)
+    * [📊 Table Recognition Pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/table_recognition_en.md)
+    * [📄 Layout Parsing Pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/layout_parsing_en.md)
+    * [📐 Formula Recognition Pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/formula_recognition_en.md)
+    * [📝 Seal Recognition Pipeline Tutorial](./docs/pipeline_usage/tutorials/ocr_pipelines/seal_recognition_en.md)
   </details>
 
 * <details open>
     <summary> <b> 🎥 Computer Vision </b></summary>
 
-   * [🖼️ Image Classification pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/image_classification_en.md)
-   * [🎯 Object Detection pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/object_detection_en.md)
-   * [📋 Instance Segmentation pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/instance_segmentation_en.md)
-   * [🗣️ Semantic Segmentation pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/semantic_segmentation_en.md)
-   * [🏷️ Multi-label Image Classification pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/image_multi_label_classification_en.md)
-   * [🔍 Small Object Detection pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/small_object_detection_en.md)
-   * [🖼️ Image Anomaly Detection pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection_en.md)
+   * [🖼️ Image Classification Pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/image_classification_en.md)
+   * [🎯 Object Detection Pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/object_detection_en.md)
+   * [📋 Instance Segmentation Pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/instance_segmentation_en.md)
+   * [🗣️ Semantic Segmentation Pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/semantic_segmentation_en.md)
+   * [🏷️ Multi-label Image Classification Pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/image_multi_label_classification_en.md)
+   * [🔍 Small Object Detection Pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/small_object_detection_en.md)
+   * [🖼️ Image Anomaly Detection Pipeline Tutorial](./docs/pipeline_usage/tutorials/cv_pipelines/image_anomaly_detection_en.md)
   </details>
 
 * <details open>
     <summary> <b> ⏱️ Time Series Analysis</b> </summary>
 
-   * [📈 Time Series Forecasting pipeline Tutorial](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_forecasting_en.md)
-   * [📉 Time Series Anomaly Detection pipeline Tutorial](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection_en.md)
-   * [🕒 Time Series Classification pipeline Tutorial](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_classification_en.md)
+   * [📈 Time Series Forecasting Pipeline Tutorial](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_forecasting_en.md)
+   * [📉 Time Series Anomaly Detection Pipeline Tutorial](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_anomaly_detection_en.md)
+   * [🕒 Time Series Classification Pipeline Tutorial](./docs/pipeline_usage/tutorials/time_series_pipelines/time_series_classification_en.md)
   </details>
 
 * <details open>

+ 5 - 7
docs/pipeline_usage/pipeline_develop_guide.md

@@ -114,15 +114,12 @@ paddlex --pipeline ./ocr.yaml --input general_ocr_002.png
 ```python
 from paddlex import create_pipeline
 
-pipeline = create_pipeline(pipeline="ocr")
+pipeline = create_pipeline(pipeline="OCR")
 
 output = pipeline.predict("general_ocr_002.png")
-for batch in output:
-    for item in batch:
-        res = item['result']
-        res.print()
-        res.save_to_img("./output/")
-        res.save_to_json("./output/")
+for res in output:
+    res.print()
+    res.save_to_img("./output/")
 ```
 
 执行了如下几个步骤:
@@ -206,6 +203,7 @@ Pipeline:
 | 图像异常检测       | [图像异常检测产线使用教程](./tutorials/cv_pipelines/image_anomaly_detection.md) |
 | 通用OCR            | [通用OCR产线使用教程](./tutorials/ocr_pipelines/OCR.md) |
 | 通用表格识别       | [通用表格识别产线使用教程](./tutorials/ocr_pipelines/table_recognition.md) |
+| 通用版面解析       | [通用版面解析产线使用教程](./tutorials/ocr_pipelines/layout_parsing.md) |
 | 公式识别       | [公式识别产线使用教程](./tutorials/ocr_pipelines/formula_recognition.md) |
 | 印章识别       | [印章识别产线使用教程](./tutorials/ocr_pipelines/seal_recognition.md) |
 | 时序预测       | [通用时序预测产线使用教程](./tutorials/time_series_pipelines/time_series_forecasting.md) |

+ 5 - 7
docs/pipeline_usage/pipeline_develop_guide_en.md

@@ -112,15 +112,12 @@ A few lines of code can quickly experience the pipeline effects:
 ```python
 from paddlex import create_pipeline
 
-pipeline = create_pipeline(pipeline="ocr")
+pipeline = create_pipeline(pipeline="OCR")
 
 output = pipeline.predict("general_ocr_002.png")
-for batch in output:
-    for item in batch:
-        res = item['result']
-        res.print()
-        res.save_to_img("./output/")
-        res.save_to_json("./output/")
+for res in output:
+    res.print()
+    res.save_to_img("./output/")
 ```
 
 The following steps are executed:
@@ -202,6 +199,7 @@ Choose the appropriate deployment method for your model pipeline based on your n
 | Image Anomaly Detection       | [Image Anomaly Detection Pipeline Usage Tutorial](./tutorials/cv_pipelines/image_anomaly_detection_en.md) |
 | OCR            | [OCR Pipeline Usage Tutorial](./tutorials/ocr_pipelines/OCR_en.md) |
 | Table Recognition       | [Table Recognition Pipeline Usage Tutorial](./tutorials/ocr_pipelines/table_recognition_en.md) |
+| Layout Parsing       | [Layout Parsing Pipeline Usage Tutorial](./tutorials/ocr_pipelines/layout_parsing_en.md) |
 | Formula Recognition       | [Formula Recognition Pipeline Usage Tutorial](./tutorials/ocr_pipelines/formula_recognition_en.md) |
 | Seal Recognition       | [Seal Recognition Pipeline Usage Tutorial](./tutorials/ocr_pipelines/seal_recognition_en.md) |
 | Time Series Forecasting       | [Time Series Forecasting Pipeline Usage Tutorial](./tutorials/time_series_pipelines/time_series_forecasting_en.md) |