rapidocr/python

RapidOCR Python

目录

• RapidOCR Python
  • 简介
  • 说明
  • pip安装快速使用（推荐）
  • 源码使用步骤

简介

• 该部分为python版的OCR推理，包括基于ONNXRuntime和OpenVINO两个推理引擎的包。
• 因为模型较小，因此将相关模型都已打到Whl包，可直接pip安装使用。

说明

• rapidocr_onnxruntime和rapidocr_openvino两个包除推理引擎不同之外，其余均相同，默认都是在CPU上运行。
• 按语义版本号来讲，两个包其主版本号和次版本号同步更新，修订号可能会有区别。也就是说x.y.z中x和y是一样的，z可能不同。
• 各个版本的对应关系：

  版本	内置模型版本	对应PaddleOCR 分支
  v1.3.x	PaddleOCR v4版	release/2.7
  v1.2.x v1.1.x v1.0.x	PaddleOCR v3版	release/2.6

• 推荐使用PaddleOCRModelConveter在线转换，现用现转。推理代码都是同一个，只需更换模型即可。已转好ONNX模型下载地址：百度网盘 | Google Drive，大家可自行搭配使用。
• 所有常用的参数配置都在config.yaml下，其中每个独立的模块下均有独立的config.yaml配置文件，可以单独使用。
• 关于选择哪个版本的包（rapidocr_onnxruntime 或者 rapidocr_openvino）?

  推理引擎	推理速度更快	占用内存更少
  rapidocr_onnxruntime		✓
  rapidocr_openvino	✓	⚠️ openvino存在内存不释放的问题，参见wiki

pip安装快速使用（推荐）

1. 安装环境

   包名	版本	安装命令
   rapidocr_onnxruntime		pip install rapidocr-onnxruntime
   rapidocr_openvino		pip install rapidocr-openvino

2. python脚本使用

   • ⚠️注意：初始化RapidOCR可不提供config.yaml，默认使用安装目录下的config.yaml。如有自定义需求：

     • 一是可直接通过初始化参数传入。详细参数参考下面命令行部分，和config.yaml基本对应。
     • 二是复制config.yaml，自行更改，然后初始化给出。e.g. engine = RapidOCR(config_path="custom.yaml")

   • 输入：Union[str, np.ndarray, bytes, Path]

   • 输出：

     • 有值：([[文本框坐标], 文本内容, 置信度], 推理时间)，e.g. [[左上, 右上, 右下, 左下], '小明', '0.99'], [0.02, 0.02, 0.85]
     • 为空：(None, None)

   • 示例：

     import cv2
     from rapidocr_onnxruntime import RapidOCR
     # from rapidocr_openvino import RapidOCR
     
     # RapidOCR可传入参数参考下面的命令行部分
     rapid_ocr = RapidOCR()
     
     img_path = 'tests/test_files/ch_en_num.jpg'
     
     # 输入格式一：str
     result, elapse = rapid_ocr(img_path)
     
     # 输入格式二：np.ndarray
     img = cv2.imread('tests/test_files/ch_en_num.jpg')
     result, elapse = rapid_ocr(img)
     
     # 输入格式三：bytes
     with open(img_path, 'rb') as f:
         img = f.read()
     result, elapse = rapid_ocr(img)
     
     # 输入格式四：Path
     result, elapse = rapid_ocr(Path(img_path))
     print(result)
     

3. 命令行使用

   • 参数说明：

     $ rapidocr_onnxruntime -h
     usage: rapidocr_onnxruntime [-h] -img IMG_PATH [-p] [--text_score TEXT_SCORE]
                                 [--use_angle_cls USE_ANGLE_CLS]
                                 [--use_text_det USE_TEXT_DET]
                                 [--print_verbose PRINT_VERBOSE]
                                 [--min_height MIN_HEIGHT]
                                 [--width_height_ratio WIDTH_HEIGHT_RATIO]
                                 [--det_use_cuda DET_USE_CUDA]
                                 [--det_model_path DET_MODEL_PATH]
                                 [--det_limit_side_len DET_LIMIT_SIDE_LEN]
                                 [--det_limit_type {max,min}]
                                 [--det_thresh DET_THRESH]
                                 [--det_box_thresh DET_BOX_THRESH]
                                 [--det_unclip_ratio DET_UNCLIP_RATIO]
                                 [--det_use_dilation DET_USE_DILATION]
                                 [--det_score_mode {slow,fast}]
                                 [--cls_use_cuda CLS_USE_CUDA]
                                 [--cls_model_path CLS_MODEL_PATH]
                                 [--cls_image_shape CLS_IMAGE_SHAPE]
                                 [--cls_label_list CLS_LABEL_LIST]
                                 [--cls_batch_num CLS_BATCH_NUM]
                                 [--cls_thresh CLS_THRESH]
                                 [--rec_use_cuda REC_USE_CUDA]
                                 [--rec_model_path REC_MODEL_PATH]
                                 [--rec_img_shape REC_IMAGE_SHAPE]
                                 [--rec_batch_num REC_BATCH_NUM]
     
     optional arguments:
     -h, --help            show this help message and exit
     -img IMG_PATH, --img_path IMG_PATH MUST
     -p, --print_cost
     
     Global:
     --text_score TEXT_SCORE
     --use_angle_cls USE_ANGLE_CLS
     --use_text_det USE_TEXT_DET
     --print_verbose PRINT_VERBOSE
     --min_height MIN_HEIGHT
     --width_height_ratio WIDTH_HEIGHT_RATIO
     
     Det:
     --det_use_cuda DET_USE_CUDA
     --det_model_path DET_MODEL_PATH
     --det_limit_side_len DET_LIMIT_SIDE_LEN
     --det_limit_type {max,min}
     --det_thresh DET_THRESH
     --det_box_thresh DET_BOX_THRESH
     --det_unclip_ratio DET_UNCLIP_RATIO
     --det_use_dilation DET_USE_DILATION
     --det_score_mode {slow,fast}
     
     Cls:
     --cls_use_cuda CLS_USE_CUDA
     --cls_model_path CLS_MODEL_PATH
     --cls_image_shape CLS_IMAGE_SHAPE
     --cls_label_list CLS_LABEL_LIST
     --cls_batch_num CLS_BATCH_NUM
     --cls_thresh CLS_THRESH
     
     Rec:
     --rec_use_cuda REC_USE_CUDA
     --rec_model_path REC_MODEL_PATH
     --rec_img_shape REC_IMAGE_SHAPE
     --rec_batch_num REC_BATCH_NUM
     

• 示例：

  $ rapidocr_onnxruntime -img tests/test_files/ch_en_num.jpg
  

源码使用步骤

1. 下载整个项目到本地

   cd RapidOCR/python
   

2. 下载链接下的resources目录（包含模型和显示的字体文件）

   • 下载链接：百度网盘 | Google Drive
   • 最终目录如下，自行比对:

     .
     ├── README.md
     ├── demo.py
     ├── rapidocr_onnxruntime
     │   ├── __init__.py
     │   ├── ch_ppocr_v2_cls
     │   ├── ch_ppocr_v3_det
     │   ├── ch_ppocr_v3_rec
     │   ├── config.yaml
     │   ├── rapid_ocr_api.py
     │   └── models
     │        ├── ch_PP-OCRv3_det_infer.onnx
     │        ├── ch_ppocr_mobile_v2.0_cls_infer.onnx
     │        └── ch_PP-OCRv3_rec_infer.onnx
     ├── rapidocr_openvino
     │   ├── __init__.py
     │   ├── README.md
     │   ├── ch_ppocr_v2_cls
     │   ├── ch_ppocr_v3_det
     │   ├── ch_ppocr_v3_rec
     │   ├── config.yaml
     │   ├── rapid_ocr_api.py
     │   └── models
     │        ├── ch_PP-OCRv3_det_infer.onnx
     │        ├── ch_ppocr_mobile_v2.0_cls_infer.onnx
     │        └── ch_PP-OCRv3_rec_infer.onnx
     ├── requirements.txt
     └── resources
           └── fonts
              └── FZYTK.TTF
     

3. 安装运行环境

   • 基于onnxruntime推理所需环境安装：

     pip install onnxruntime>=1.7.0
     pip install -r requirements.txt
     

   • 基于openvino推理所需环境安装：

     pip install openvino
     pip install -r requirements.txt
     

   • ⚠️: 在Windows端，Shapely库自动安装可能会有问题，解决方案参见Q15

4. 运行示例

   • 运行单元测试

     pytest tests/test_*.py
     

   • 接口调用

     import cv2
     
     # 基于onnxruntime引擎推理
     from rapidocr_onnxruntime import RapidOCR
     
     # 基于openvino引擎推理
     # from rapidocr_openvino import RapidOCR
     
     rapid_ocr = RapidOCR()
     
     image_path = r'test_images/det_images/ch_en_num.jpg'
     img = cv2.imread(image_path)
     
     result = rapid_ocr(img)
     print(result)
     
     # result: [[文本框坐标], 文本内容, 置信度]
     # 示例：[[左上, 右上, 右下, 左下], '小明', '0.99']
     

   • 直接运行demo.py，可直接可视化查看结果。

     python demo.py