Skip to content

quick_start.md

Latest commit

 

History

History
121 lines (85 loc) · 5 KB

quick_start.md

File metadata and controls

121 lines (85 loc) · 5 KB

PaddleX快速开始

🛠️ 安装

❗安装PaddleX前请先确保您有基础的Python运行环境

  • 安装PaddlePaddle
# cpu
python -m pip install paddlepaddle==3.0.0b2 -i https://www.paddlepaddle.org.cn/packages/stable/cpu/

# gpu，该命令仅适用于 CUDA 版本为 11.8 的机器环境
python -m pip install paddlepaddle-gpu==3.0.0b2 -i https://www.paddlepaddle.org.cn/packages/stable/cu118/

# gpu，该命令仅适用于 CUDA 版本为 12.3 的机器环境
python -m pip install paddlepaddle-gpu==3.0.0b2 -i https://www.paddlepaddle.org.cn/packages/stable/cu123/
  • 安装PaddleX
git clone https://github.com/PaddlePaddle/PaddleX.git
cd PaddleX
pip install -e .

更多安装方式参考PaddleX安装教程

💻 命令行使用

一行命令即可快速体验产线效果，统一的命令行格式为：

paddlex --pipeline [产线名称] --input [输入图片] --device [运行设备]

只需指定三个参数：

  • pipeline：产线名称
  • input：待处理的输入图片的本地路径或URL
  • device: 使用的GPU序号（例如gpu:0表示使用第0块GPU），也可选择使用CPU（cpu）

以通用OCR产线为例：

paddlex --pipeline OCR --input https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/general_ocr_002.png --device gpu:0

运行后的结果如下：

The prediction result is:
['登机口于起飞前10分钟关闭']
The prediction result is:
['GATES CLOSE 1O MINUTESBEFORE DEPARTURE TIME']
The prediction result is:
['ETKT7813699238489/1']
......

可视化结果如下：

alt text

其他产线的命令行使用，只需将pipeline参数调整为相应产线的名称。下面列出了每个产线对应的参数名称及详细的使用解释：

产线名称 对应参数 详细说明
通用OCR产线 OCR 通用OCR产线命令行使用说明
通用表格识别产线 table_recognition 通用表格识别产线命令行使用说明
PP-ChatOCRv3产线 pp_chatocrv3 PP-ChatOCRv3产线命令行使用说明

📝 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脚本使用说明
通用表格识别产线 table_recognition 通用表格识别产线Python脚本使用说明
PP-ChatOCRv3产线 pp_chatocrv3 PP-ChatOCRv3产线Python脚本使用说明

🌟 更多

PaddleX的各个产线均支持在线体验和本地快速推理，您可以快速体验各个产线的预训练效果，如果您对产线的预训练效果满意，可以直接对产线进行高性能部署/服务化部署/端侧部署，如果不满意，您也可以对产线进行二次开发提升产线效果。完整的产线开发流程请参考PaddleX产线开发工具本地使用教程。

此外，PaddleX为OCR相关的每个产线和单功能模块都提供了详细的开发教程，您可以根据需要选择对应的产线或模块进行开发：