From 397b5641f9326da4f4f08a1a4e8f29ccd81a078c Mon Sep 17 00:00:00 2001 From: dyning Date: Tue, 1 Oct 2024 06:44:47 +0800 Subject: [PATCH] =?UTF-8?q?updata=202.9,=20adding=20new=20models=20and=20s?= =?UTF-8?q?upporting=20all-in-one=20full=20developm=E2=80=A6=20(#13933)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * updata 2.9, adding new models and supporting all-in-one full development tools * updata 2.9, adding new models and supporting all-in-one full development tools --- README.md | 7 ++- docs/index.md | 4 +- docs/paddlex/overview.md | 14 ------ docs/paddlex/quick_start.md | 95 +++++++++++++++++++++---------------- mkdocs.yml | 6 +-- 5 files changed, 61 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index d0e047594e..820aca3a3c 100644 --- a/README.md +++ b/README.md @@ -33,8 +33,8 @@ PaddleOCR 由 [PMC](https://github.com/PaddlePaddle/PaddleOCR/issues/12122) 监 - **🔥2024.10.1 发布PaddleOCR 2.9**: * 飞桨一站式全流程开发工具PaddleX，依托于PaddleOCR的先进技术，支持了OCR领域的一站式全流程开发能力： - * 🎨 [**模型丰富一键调用**](https://paddlepaddle.github.io/PaddleOCR/paddlex/quick_start.md)：将文本图像智能分析、通用OCR、通用表格识别、公式识别、印章识别涉及的**17个模型**整合为5条模型产线，通过极简的**Python API一键调用**，快速体验模型效果。此外，同一套API，也支持图像分类、目标检测、图像分割、时序预测等共计**200+模型**，形成20+单功能模块，方便开发者进行**模型组合**使用。 - * 🚀[**提高效率降低门槛**](https://paddlepaddle.github.io/PaddleOCR/paddlex/overview.md)：提供基于**统一命令**和**图形界面**两种方式，实现模型简洁高效的使用、组合与定制。支持**高性能部署、服务化部署和端侧部署**等多种部署方式。此外，对于各种主流硬件如**英伟达GPU、昆仑芯、昇腾、寒武纪和海光**等，进行模型开发时，都可以**无缝切换**。 + * 🎨 [**模型丰富一键调用**](https://paddlepaddle.github.io/PaddleOCR/paddlex/quick_start.html)：将文本图像智能分析、通用OCR、通用表格识别、公式识别、印章识别涉及的**17个模型**整合为5条模型产线，通过极简的**Python API一键调用**，快速体验模型效果。此外，同一套API，也支持图像分类、目标检测、图像分割、时序预测等共计**200+模型**，形成20+单功能模块，方便开发者进行**模型组合**使用。 + * 🚀[**提高效率降低门槛**](https://paddlepaddle.github.io/PaddleOCR/paddlex/overview.html)：提供基于**统一命令**和**图形界面**两种方式，实现模型简洁高效的使用、组合与定制。支持**高性能部署、服务化部署和端侧部署**等多种部署方式。此外，对于各种主流硬件如**英伟达GPU、昆仑芯、昇腾、寒武纪和海光**等，进行模型开发时，都可以**无缝切换**。 * 支持文档场景信息抽取v3([PP-ChatOCRv3](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/tutorials/information_extration_pipelines/document_scene_information_extraction.md))、基于RT-DETR和PicoDet的[高精度版面区域检测模型](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/layout_detection.md)、高精度表格结构识别模型[SLANet_Plus](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/table_structure_recognition.md)、版面矫正预测模型[UVDoc](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/text_image_unwarping.md)、公式识别模型[LatexOCR](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/formula_recognition.md)、基于PP-LCNet的[文档图像方向分类模型](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/doc_img_orientation_classification.md) @@ -42,7 +42,6 @@ PaddleOCR 由 [PMC](https://github.com/PaddlePaddle/PaddleOCR/issues/12122) 监 - 赛题一：OCR 端到端识别任务冠军方案——[场景文本识别算法-SVTRv2](https://paddlepaddle.github.io/PaddleOCR/algorithm/text_recognition/algorithm_rec_svtrv2.html)； - 赛题二：通用表格识别任务冠军方案——[表格识别算法-SLANet-LCNetV2](https://paddlepaddle.github.io/PaddleOCR/algorithm/table_recognition/algorithm_table_slanet.html)。 -> [更多](https://paddlepaddle.github.io/PaddleOCR/update.md) ## 🌟 特性 @@ -54,7 +53,7 @@ PaddleOCR 由 [PMC](https://github.com/PaddlePaddle/PaddleOCR/issues/12122) 监 ## ⚡ [快速开始](https://paddlepaddle.github.io/PaddleOCR/quick_start.html) -## 🔥 [一站式全流程开发](https://paddlepaddle.github.io/PaddleOCR/paddlex/overview.md) +## 🔥 [一站式全流程开发](https://paddlepaddle.github.io/PaddleOCR/paddlex/overview.html) ## 📝 文档 diff --git a/docs/index.md b/docs/index.md index 7ad415f069..067399b639 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,8 +33,8 @@ PaddleOCR 由 [PMC](https://github.com/PaddlePaddle/PaddleOCR/issues/12122) 监 - **🔥2024.10.1 发布PaddleOCR release/2.9**: * 飞桨一站式全流程开发工具PaddleX，依托于PaddleOCR的先进技术，支持了OCR领域的一站式全流程开发能力： - * 🎨 [**模型丰富一键调用**](https://paddlepaddle.github.io/PaddleOCR/paddlex/quick_start.md)：将文本图像智能分析、通用OCR、通用表格识别、公式识别、印章识别涉及的**17个模型**整合为5条模型产线，通过极简的**Python API一键调用**，快速体验模型效果。此外，同一套API，也支持图像分类、目标检测、图像分割、时序预测等共计**200+模型**，形成20+单功能模块，方便开发者进行**模型组合**使用。 - * 🚀[**提高效率降低门槛**](https://paddlepaddle.github.io/PaddleOCR/paddlex/overview.md)：提供基于**统一命令**和**图形界面**两种方式，实现模型简洁高效的使用、组合与定制。支持**高性能部署、服务化部署和端侧部署**等多种部署方式。此外，对于各种主流硬件如**英伟达GPU、昆仑芯、昇腾、寒武纪和海光**等，进行模型开发时，都可以**无缝切换**。 + * 🎨 [**模型丰富一键调用**](https://paddlepaddle.github.io/PaddleOCR/paddlex/quick_start.html)：将文本图像智能分析、通用OCR、通用表格识别、公式识别、印章识别涉及的**17个模型**整合为5条模型产线，通过极简的**Python API一键调用**，快速体验模型效果。此外，同一套API，也支持图像分类、目标检测、图像分割、时序预测等共计**200+模型**，形成20+单功能模块，方便开发者进行**模型组合**使用。 + * 🚀[**提高效率降低门槛**](https://paddlepaddle.github.io/PaddleOCR/paddlex/overview.html)：提供基于**统一命令**和**图形界面**两种方式，实现模型简洁高效的使用、组合与定制。支持**高性能部署、服务化部署和端侧部署**等多种部署方式。此外，对于各种主流硬件如**英伟达GPU、昆仑芯、昇腾、寒武纪和海光**等，进行模型开发时，都可以**无缝切换**。 * 支持文档场景信息抽取v3([PP-ChatOCRv3](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/tutorials/information_extration_pipelines/document_scene_information_extraction.md))、基于RT-DETR和PicoDet的[高精度版面区域检测模型](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/layout_detection.md)、高精度表格结构识别模型[SLANet_Plus](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/table_structure_recognition.md)、版面矫正预测模型[UVDoc](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/text_image_unwarping.md)、公式识别模型[LatexOCR](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/formula_recognition.md)、基于PP-LCNet的[文档图像方向分类模型](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/doc_img_orientation_classification.md) diff --git a/docs/paddlex/overview.md b/docs/paddlex/overview.md index cb45301b53..0c17ee0604 100644 --- a/docs/paddlex/overview.md +++ b/docs/paddlex/overview.md @@ -1,12 +1,4 @@ -## 目录 -- [一站式全流程开发简介](#1) -- [OCR相关能力支持](#2) -- [OCR相关模型产线列表和教程](#3) -- [OCR相关单功能模块列表和教程](#4) - - - ## 1. 一站式全流程开发简介 飞桨一站式全流程开发工具[PaddleX](https://github.com/PaddlePaddle/PaddleX/tree/release/3.0-beta1)，依托于PaddleOCR的先进技术，支持了OCR领域的**一站式全流程**开发能力。通过一站式全流程开发，可实现简单且高效的模型使用、组合与定制。这将显著**减少模型开发的时间消耗**，**降低其开发难度**，大大加快模型在行业中的应用和推广速度。特色如下： @@ -17,8 +9,6 @@ >**说明**：PaddleX 致力于实现产线级别的模型训练、推理与部署。模型产线是指一系列预定义好的、针对特定AI任务的开发流程，其中包含能够独立完成某类任务的单模型（单功能模块）组合。 - - ## 2. OCR相关能力支持 PaddleX中OCR相关的5条产线均支持本地**快速推理**，部分产线支持**在线体验**，您可以快速体验各个产线的预训练模型效果，如果您对产线的预训练模型效果满意，可以直接对产线进行[高性能部署](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_deploy/high_performance_deploy.md)/[服务化部署](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_deploy/service_deploy.md)/[端侧部署](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_deploy/lite_deploy.md)，如果不满意，您也可以使用产线的**二次开发**能力，提升效果。完整的产线开发流程请参考[PaddleX产线使用概览](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/pipeline_develop_guide.md)或各产线使用教程。 @@ -119,16 +109,12 @@ PaddleX中OCR相关的5条产线均支持本地**快速推理**，部分产线 - - ## 3. OCR相关模型产线列表和教程 - **通用OCR产线**: [使用教程](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/tutorials/ocr_pipelines/OCR.md) - **通用表格识别产线**: [使用教程](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/tutorials/ocr_pipelines/table_recognition.md) - **文档场景信息抽取v3产线**: [使用教程](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/tutorials/information_extration_pipelines/document_scene_information_extraction.md) - - ## 4. OCR相关单功能模块列表和教程 - **文本检测模块**: [使用教程](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/module_usage/tutorials/ocr_modules/text_detection.md) diff --git a/docs/paddlex/quick_start.md b/docs/paddlex/quick_start.md index 72d56c9f2c..ff8d0f8674 100644 --- a/docs/paddlex/quick_start.md +++ b/docs/paddlex/quick_start.md @@ -1,7 +1,9 @@ # 快速开始 >**说明：** + >* 飞桨一站式全流程开发工具[PaddleX](https://github.com/PaddlePaddle/PaddleX/tree/release/3.0-beta1)，依托于PaddleOCR的先进技术，支持了OCR领域的**一站式全流程**开发能力。通过一站式全流程开发，可实现简单且高效的模型使用、组合与定制。 + >* PaddleX 致力于实现产线级别的模型训练、推理与部署。模型产线是指一系列预定义好的、针对特定AI任务的开发流程，其中包含能够独立完成某类任务的单模型（单功能模块）组合。本文档提供**OCR相关产线**的快速使用，单功能模块的快速使用以及更多功能请参考[PaddleOCR一站式全流程开发](https://paddlepaddle.github.io/PaddleOCR/paddlex/overview.md)中相关章节。 @@ -11,23 +13,58 @@ * **安装PaddlePaddle** ```bash # cpu -python -m pip install paddlepaddle +python -m pip install paddlepaddle==3.0.0b1 -i https://www.paddlepaddle.org.cn/packages/stable/cpu/ # gpu，该命令仅适用于 CUDA 版本为 11.8 的机器环境 - python -m pip install paddlepaddle-gpu==3.0.0b1 -i https://www.paddlepaddle.org.cn/packages/stable/cu118/ +python -m pip install paddlepaddle-gpu==3.0.0b1 -i https://www.paddlepaddle.org.cn/packages/stable/cu118/ # gpu，该命令仅适用于 CUDA 版本为 12.3 的机器环境 - python -m pip install paddlepaddle-gpu==3.0.0b1 -i https://www.paddlepaddle.org.cn/packages/stable/cu123/ +python -m pip install paddlepaddle-gpu==3.0.0b1 -i https://www.paddlepaddle.org.cn/packages/stable/cu123/ ``` > ❗ 更多飞桨 Wheel 版本请参考[飞桨官网](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/pip/linux-pip.html)。 * **安装PaddleX** ```bash -pip install https://paddle-model-ecology.bj.bcebos.com/paddlex/whl/paddlex-3.0.0.beta1-py3-none-any.whl +pip install https://paddle-model-ecology.bj.bcebos.com/paddlex/whl/paddlex-3.0.0b1-py3-none-any.whl ``` -> ❗ 更多安装方式参考[PaddleX安装教程](./installation/installation.md) +> ❗ 更多安装方式参考[PaddleX安装教程](https://github.com/PaddlePaddle/PaddleX/blob/develop/docs/installation/installation.md) + +### 📝 Python 脚本使用 + +三行代码即可完成产线的快速推理，统一的 Python 脚本格式如下： +```python +from paddlex import create_pipeline + +pipeline = create_pipeline(pipeline=[产线名称]) +output = pipeline.predict([输入图片名称]) +for res in output: + res.print() + res.save_to_img("./output/") + res.save_to_json("./output/") +``` +执行了如下几个步骤： + +* `create_pipeline()` 实例化产线对象 +* 传入图片并调用产线对象的 `predict` 方法进行推理预测 +* 对预测结果进行处理 + +其他产线的 Python 脚本使用，只需将 `create_pipeline()` 方法的 `pipeline` 参数调整为相应产线的名称。下面列出了每个产线对应的参数名称及详细的使用解释： +
+ 👉 更多产线的Python脚本使用 + +| 产线名称 | 对应参数 | 详细说明 | +|--------------------|------------------------|---------------------------------------------------------------------------------------------------------------| +| 文档场景信息抽取v3 | `PP-ChatOCRv3-doc` | [文档场景信息抽取v3产线Python脚本使用说明](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/tutorials/information_extration_pipelines/document_scene_information_extraction.md#22-本地体验) | +| 通用OCR | `OCR` | [通用OCR产线Python脚本使用说明](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/tutorials/ocr_pipelines/OCR.md#222-python脚本方式集成) | +| 通用表格识别 | `table_recognition` | [通用表格识别产线Python脚本使用说明](https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta1/docs/pipeline_usage/tutorials/ocr_pipelines/table_recognition.md#22-python脚本方式集成) | +| 印章识别 | coming soon | coming soon | +| 公式识别 | coming soon | coming soon | + + +
+ ### 💻 命令行使用 一行命令即可快速体验产线效果，统一的命令行格式为： @@ -38,11 +75,11 @@ paddlex --pipeline [产线名称] --input [输入图片] --device [运行设备] 只需指定三个参数： * `pipeline`：产线名称 -* `input`：待处理的输入图片的本地路径或URL -* `device`: 使用的GPU序号（例如`gpu:0`表示使用第0块GPU），也可选择使用CPU（`cpu`） +* `input`：待处理的输入文件（如图片）的本地路径或 URL +* `device`: 使用的 GPU 序号（例如`gpu:0`表示使用第 0 块 GPU），也可选择使用 CPU（`cpu`） -以通用OCR产线为例： +以通用 OCR 产线为例： ```bash paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_002.png --device gpu:0 ``` @@ -56,46 +93,20 @@ paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddle 可视化结果如下： -![alt text](./imgs/boardingpass.png) +![alt text](https://raw.githubusercontent.com/cuicheng01/PaddleX_doc_images/main/images/boardingpass.png) -其他产线的命令行使用，只需将`pipeline`参数调整为相应产线的名称。下面列出了每个产线对应的命令： +其他产线的命令行使用，只需将 `pipeline` 参数调整为相应产线的名称。下面列出了每个产线对应的命令： +
+ 👉 更多产线的命令行使用 | 产线名称 | 使用命令 | |-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 文档场景信息抽取 | | -| 通用图像分类 | `paddlex --pipeline image_classification --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_image_classification_001.jpg --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` | +|文档场景信息抽取v3 | coming soon | +| 印章识别 | coming soon | +| 公式识别 | coming soon | - -### 📝 Python脚本使用 - -几行代码即可完成产线的快速推理，统一的Python脚本格式如下： -```python -from paddlex import create_pipeline - -pipeline = create_pipeline(pipeline=[产线名称]) -output = pipeline.predict([输入图片名称]) -for batch in output: - for item in batch: - res = item['result'] - res.print() - res.save_to_img("./output/") - res.save_to_json("./output/") -``` -执行了如下几个步骤： - -* `create_pipeline()` 实例化产线对象 -* 传入图片并调用产线对象的`predict` 方法进行推理预测 -* 对预测结果进行处理 - -其他产线的Python脚本使用，只需将`create_pipeline()`方法的`pipeline`参数调整为相应产线的名称。下面列出了每个产线对应的参数名称及详细的使用解释： - -| 产线名称 | 对应参数 | 详细说明 | -|----------|----------------------|------| -| 通用OCR产线 | `OCR` | [通用OCR产线Python脚本使用说明](./pipeline_usage/OCR.md#222-python脚本方式集成) | -| 通用表格识别产线 | `table_recognition` | [通用表格识别产线Python脚本使用说明](./pipeline_usage/table_recognition.md#22-python脚本方式集成) | -| PP-ChatOCRv3产线 | `pp_chatocrv3` | [PP-ChatOCRv3产线Python脚本使用说明](./pipeline_usage/document_scene_information_extraction.md#222-python脚本方式集成) | +
diff --git a/mkdocs.yml b/mkdocs.yml index 0476f6f018..a6606e03d0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -254,14 +254,14 @@ nav: - Home: index.md - 快速开始: quick_start.md - 近期更新: update.md + - 一站式全流程开发: + - 概述: paddlex/overview.md + - 快速开始: paddlex/quick_start.md - 模型: - 概览: model/index.md - 多硬件安装飞桨: - 多硬件安装飞桨: model/hardware/install_other_devices.md - 支持硬件列表: model/hardware/supported_models.md - - 一站式全流程开发: - - 概述: paddlex/overview.md - - 快速开始: paddlex/quick_start.md - PP-OCR 文本检测识别: - 概述: ppocr/overview.md - 快速开始: ppocr/quick_start.md