paddleocr package使用说明

快速上手

1.1 安装whl包

pip安装

pip install "paddleocr>=2.0.1" # 推荐使用2.0.1+版本

本地构建并安装

python3 setup.py bdist_wheelpip3 install dist/paddleocr-x.x.x-py3-none-any.whl # x.x.x是paddleocr的版本号

2 使用

2.1 代码使用

paddleocr whl包会自动下载ppocr轻量级模型作为默认模型，可以根据第3节自定义模型进行自定义更换。

• 检测+方向分类器+识别全流程

from paddleocr import PaddleOCR, draw_ocr# Paddleocr目前支持中英文、英文、法语、德语、韩语、日语，可以通过修改lang参数进行切换# 参数依次为`ch`, `en`, `french`, `german`, `korean`, `japan`。ocr = PaddleOCR(use_angle_cls=True, lang="ch") # need to run only once to download and load model into memoryimg_path = 'PaddleOCR/doc/imgs/11.jpg'result = ocr.ocr(img_path, cls=True)for line in result:    print(line)# 显示结果from PIL import Imageimage = Image.open(img_path).convert('RGB')boxes = [line[0] for line in result]txts = [line[1][0] for line in result]scores = [line[1][1] for line in result]im_show = draw_ocr(image, boxes, txts, scores, font_path='/path/to/PaddleOCR/doc/fonts/simfang.ttf')im_show = Image.fromarray(im_show)im_show.save('result.jpg')

结果是一个list，每个item包含了文本框，文字和识别置信度

[[[24.0, 36.0], [304.0, 34.0], [304.0, 72.0], [24.0, 74.0]], ['纯臻营养护发素', 0.964739]][[[24.0, 80.0], [172.0, 80.0], [172.0, 104.0], [24.0, 104.0]], ['产品信息/参数', 0.98069626]][[[24.0, 109.0], [333.0, 109.0], [333.0, 136.0], [24.0, 136.0]], ['（45元/每公斤，100公斤起订）', 0.9676722]]......

结果可视化

• 检测+识别

from paddleocr import PaddleOCR, draw_ocrocr = PaddleOCR() # need to run only once to download and load model into memoryimg_path = 'PaddleOCR/doc/imgs/11.jpg'result = ocr.ocr(img_path)for line in result:    print(line)# 显示结果from PIL import Imageimage = Image.open(img_path).convert('RGB')boxes = [line[0] for line in result]txts = [line[1][0] for line in result]scores = [line[1][1] for line in result]im_show = draw_ocr(image, boxes, txts, scores, font_path='/path/to/PaddleOCR/doc/fonts/simfang.ttf')im_show = Image.fromarray(im_show)im_show.save('result.jpg')

结果是一个list，每个item包含了文本框，文字和识别置信度

[[[24.0, 36.0], [304.0, 34.0], [304.0, 72.0], [24.0, 74.0]], ['纯臻营养护发素', 0.964739]][[[24.0, 80.0], [172.0, 80.0], [172.0, 104.0], [24.0, 104.0]], ['产品信息/参数', 0.98069626]][[[24.0, 109.0], [333.0, 109.0], [333.0, 136.0], [24.0, 136.0]], ['（45元/每公斤，100公斤起订）', 0.9676722]]......

结果可视化

• 方向分类器+识别

from paddleocr import PaddleOCRocr = PaddleOCR(use_angle_cls=True) # need to run only once to download and load model into memoryimg_path = 'PaddleOCR/doc/imgs_words/ch/word_1.jpg'result = ocr.ocr(img_path, det=False, cls=True)for line in result:    print(line)

结果是一个list，每个item只包含识别结果和识别置信度

['韩国小馆', 0.9907421]

• 单独执行检测

from paddleocr import PaddleOCR, draw_ocrocr = PaddleOCR() # need to run only once to download and load model into memoryimg_path = 'PaddleOCR/doc/imgs/11.jpg'result = ocr.ocr(img_path, rec=False)for line in result:    print(line)# 显示结果from PIL import Imageimage = Image.open(img_path).convert('RGB')im_show = draw_ocr(image, result, txts=None, scores=None, font_path='/path/to/PaddleOCR/doc/fonts/simfang.ttf')im_show = Image.fromarray(im_show)im_show.save('result.jpg')

结果是一个list，每个item只包含文本框

[[26.0, 457.0], [137.0, 457.0], [137.0, 477.0], [26.0, 477.0]][[25.0, 425.0], [372.0, 425.0], [372.0, 448.0], [25.0, 448.0]][[128.0, 397.0], [273.0, 397.0], [273.0, 414.0], [128.0, 414.0]]......

结果可视化

• 单独执行识别

from paddleocr import PaddleOCRocr = PaddleOCR() # need to run only once to download and load model into memoryimg_path = 'PaddleOCR/doc/imgs_words/ch/word_1.jpg'result = ocr.ocr(img_path, det=False)for line in result:    print(line)

结果是一个list，每个item只包含识别结果和识别置信度

['韩国小馆', 0.9907421]

• 单独执行方向分类器

from paddleocr import PaddleOCRocr = PaddleOCR(use_angle_cls=True) # need to run only once to download and load model into memoryimg_path = 'PaddleOCR/doc/imgs_words/ch/word_1.jpg'result = ocr.ocr(img_path, det=False, rec=False, cls=True)for line in result:    print(line)

结果是一个list，每个item只包含分类结果和分类置信度

['0', 0.9999924]

2.2 通过命令行使用

查看帮助信息

paddleocr -h

• 检测+方向分类器+识别全流程

paddleocr --image_dir PaddleOCR/doc/imgs/11.jpg --use_angle_cls true

结果是一个list，每个item包含了文本框，文字和识别置信度

[[[24.0, 36.0], [304.0, 34.0], [304.0, 72.0], [24.0, 74.0]], ['纯臻营养护发素', 0.964739]][[[24.0, 80.0], [172.0, 80.0], [172.0, 104.0], [24.0, 104.0]], ['产品信息/参数', 0.98069626]][[[24.0, 109.0], [333.0, 109.0], [333.0, 136.0], [24.0, 136.0]], ['（45元/每公斤，100公斤起订）', 0.9676722]]......

• 检测+识别

paddleocr --image_dir PaddleOCR/doc/imgs/11.jpg

结果是一个list，每个item包含了文本框，文字和识别置信度

[[[24.0, 36.0], [304.0, 34.0], [304.0, 72.0], [24.0, 74.0]], ['纯臻营养护发素', 0.964739]][[[24.0, 80.0], [172.0, 80.0], [172.0, 104.0], [24.0, 104.0]], ['产品信息/参数', 0.98069626]][[[24.0, 109.0], [333.0, 109.0], [333.0, 136.0], [24.0, 136.0]], ['（45元/每公斤，100公斤起订）', 0.9676722]]......

• 方向分类器+识别

paddleocr --image_dir PaddleOCR/doc/imgs_words/ch/word_1.jpg --use_angle_cls true --det false

结果是一个list，每个item只包含识别结果和识别置信度

['韩国小馆', 0.9907421]

• 单独执行检测

paddleocr --image_dir PaddleOCR/doc/imgs/11.jpg --rec false

结果是一个list，每个item只包含文本框

[[26.0, 457.0], [137.0, 457.0], [137.0, 477.0], [26.0, 477.0]][[25.0, 425.0], [372.0, 425.0], [372.0, 448.0], [25.0, 448.0]][[128.0, 397.0], [273.0, 397.0], [273.0, 414.0], [128.0, 414.0]]......

• 单独执行识别

paddleocr --image_dir PaddleOCR/doc/imgs_words/ch/word_1.jpg --det false

结果是一个list，每个item只包含识别结果和识别置信度

['韩国小馆', 0.9907421]

• 单独执行方向分类器

paddleocr --image_dir PaddleOCR/doc/imgs_words/ch/word_1.jpg --use_angle_cls true --det false --rec false

结果是一个list，每个item只包含分类结果和分类置信度

['0', 0.9999924]

3 自定义模型

当内置模型无法满足需求时，需要使用到自己训练的模型。 首先，参照inference.md 第一节转换将检测、分类和识别模型转换为inference模型，然后按照如下方式使用

3.1 代码使用

from paddleocr import PaddleOCR, draw_ocr# 模型路径下必须含有model和params文件ocr = PaddleOCR(det_model_dir='{your_det_model_dir}', rec_model_dir='{your_rec_model_dir}', rec_char_dict_path='{your_rec_char_dict_path}', cls_model_dir='{your_cls_model_dir}', use_angle_cls=True)img_path = 'PaddleOCR/doc/imgs/11.jpg'result = ocr.ocr(img_path, cls=True)for line in result:    print(line)# 显示结果from PIL import Imageimage = Image.open(img_path).convert('RGB')boxes = [line[0] for line in result]txts = [line[1][0] for line in result]scores = [line[1][1] for line in result]im_show = draw_ocr(image, boxes, txts, scores, font_path='/path/to/PaddleOCR/doc/fonts/simfang.ttf')im_show = Image.fromarray(im_show)im_show.save('result.jpg')

3.2 通过命令行使用

paddleocr --image_dir PaddleOCR/doc/imgs/11.jpg --det_model_dir {your_det_model_dir} --rec_model_dir {your_rec_model_dir} --rec_char_dict_path {your_rec_char_dict_path} --cls_model_dir {your_cls_model_dir} --use_angle_cls true

4 使用网络图片或者numpy数组作为输入

4.1 网络图片

• 代码使用

from paddleocr import PaddleOCR, draw_ocr# Paddleocr目前支持中英文、英文、法语、德语、韩语、日语，可以通过修改lang参数进行切换# 参数依次为`ch`, `en`, `french`, `german`, `korean`, `japan`。ocr = PaddleOCR(use_angle_cls=True, lang="ch") # need to run only once to download and load model into memoryimg_path = 'http://n.sinaimg.cn/ent/transform/w630h933/20171222/o111-fypvuqf1838418.jpg'result = ocr.ocr(img_path, cls=True)for line in result:    print(line)# 显示结果from PIL import Imageimage = Image.open(img_path).convert('RGB')boxes = [line[0] for line in result]txts = [line[1][0] for line in result]scores = [line[1][1] for line in result]im_show = draw_ocr(image, boxes, txts, scores, font_path='/path/to/PaddleOCR/doc/fonts/simfang.ttf')im_show = Image.fromarray(im_show)im_show.save('result.jpg')

• 命令行模式

paddleocr --image_dir http://n.sinaimg.cn/ent/transform/w630h933/20171222/o111-fypvuqf1838418.jpg --use_angle_cls=true

4.2 numpy数组

仅通过代码使用时支持numpy数组作为输入

from paddleocr import PaddleOCR, draw_ocr# Paddleocr目前支持中英文、英文、法语、德语、韩语、日语，可以通过修改lang参数进行切换# 参数依次为`ch`, `en`, `french`, `german`, `korean`, `japan`。ocr = PaddleOCR(use_angle_cls=True, lang="ch") # need to run only once to download and load model into memoryimg_path = 'PaddleOCR/doc/imgs/11.jpg'img = cv2.imread(img_path)# img = cv2.cvtColor(img,cv2.COLOR_BGR2GRAY), 如果你自己训练的模型支持灰度图，可以将这句话的注释取消result = ocr.ocr(img, cls=True)for line in result:    print(line)# 显示结果from PIL import Imageimage = Image.open(img_path).convert('RGB')boxes = [line[0] for line in result]txts = [line[1][0] for line in result]scores = [line[1][1] for line in result]im_show = draw_ocr(image, boxes, txts, scores, font_path='/path/to/PaddleOCR/doc/fonts/simfang.ttf')im_show = Image.fromarray(im_show)im_show.save('result.jpg')

5 参数说明