PaddleOCR/README_ch.md

177 lines
12 KiB
Markdown
Raw Permalink Normal View History

2020-10-13 17:49:16 +08:00
[English](README.md) | 简体中文
2021-06-09 11:16:38 +08:00
------------------------------------------------------------------------------------------
<p align="left">
<a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-dfd.svg"></a>
<a href="https://github.com/PaddlePaddle/PaddleOCR/releases"><img src="https://img.shields.io/github/v/release/PaddlePaddle/PaddleOCR?color=ffa"></a>
<a href=""><img src="https://img.shields.io/badge/python-3.7+-aff.svg"></a>
<a href=""><img src="https://img.shields.io/badge/os-linux%2C%20win%2C%20mac-pink.svg"></a>
<a href=""><img src="https://img.shields.io/pypi/format/PaddleOCR?color=c77"></a>
<a href="https://github.com/PaddlePaddle/PaddleOCR/graphs/contributors"><img src="https://img.shields.io/github/contributors/PaddlePaddle/PaddleOCR?color=9ea"></a>
<a href="https://pypi.org/project/PaddleOCR/"><img src="https://img.shields.io/pypi/dm/PaddleOCR?color=9cf"></a>
<a href="https://github.com/PaddlePaddle/PaddleOCR/stargazers"><img src="https://img.shields.io/github/stars/PaddlePaddle/PaddleOCR?color=ccf"></a>
</p>
2020-10-13 17:49:16 +08:00
## 简介
PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库助力使用者训练出更好的模型并应用落地。
2020-12-16 00:44:40 +08:00
## 注意
PaddleOCR同时支持动态图与静态图两种编程范式
2021-05-24 13:49:15 +08:00
- 动态图版本release/2.1默认分支开发分支为dygraph分支需将paddle版本升级至2.0.0或以上版本([快速安装](./doc/doc_ch/installation.md)
2020-12-16 00:44:40 +08:00
- 静态图版本develop分支
2020-10-13 17:49:16 +08:00
**近期更新**
2021-06-29 14:30:31 +08:00
- 2021.6.29 [FAQ](./doc/doc_ch/FAQ.md)新增5个高频问题总数248个每周一都会更新欢迎大家持续关注。
2021-05-12 11:38:40 +08:00
- PaddleOCR研发团队对最新发版内容技术深入解读4月13日晚上19:00[直播地址](https://live.bilibili.com/21689802)。
2021-04-09 20:28:28 +08:00
- 2021.4.8 release 2.1版本新增AAAI 2021论文[端到端识别算法PGNet](./doc/doc_ch/pgnet.md)开源,[多语言模型](./doc/doc_ch/multi_languages.md)支持种类增加到80+。
2021-05-12 11:38:40 +08:00
- 2021.2.8 正式发布PaddleOCRv2.0(branch release/2.0)并设置为推荐用户使用的默认分支. 发布的详细内容,请参考: https://github.com/PaddlePaddle/PaddleOCR/releases/tag/v2.0.0
- 2021.1.26,28,29 PaddleOCR官方研发团队带来技术深入解读三日直播课1月26日、28日、29日晚上19:30[直播地址](https://live.bilibili.com/21689802)
2020-10-13 17:49:16 +08:00
- [More](./doc/doc_ch/update.md)
2020-12-09 20:18:10 +08:00
2020-10-13 17:49:16 +08:00
## 特性
- PPOCR系列高质量预训练模型准确的识别效果
2020-12-15 22:50:57 +08:00
- 超轻量ppocr_mobile移动端系列检测3.0M+方向分类器1.4M+ 识别5.0M= 9.4M
- 通用ppocr_server系列检测47.1M+方向分类器1.4M+ 识别94.9M= 143.4M
2020-12-15 22:37:52 +08:00
- 支持中英文数字组合识别、竖排文本识别、长文本识别
2021-05-12 11:38:40 +08:00
- 支持80+多语言识别,详见[多语言模型](./doc/doc_ch/multi_languages.md)
2020-12-15 22:37:52 +08:00
- 丰富易用的OCR相关工具组件
- 半自动数据标注工具PPOCRLabel支持快速高效的数据标注
- 数据合成工具Style-Text批量合成大量与目标场景类似的图像
2020-10-13 17:49:16 +08:00
- 支持用户自定义训练,提供丰富的预测推理部署方案
- 支持PIP快速安装使用
- 可运行于Linux、Windows、MacOS等多种系统
## 效果展示
<div align="center">
2020-12-15 16:14:38 +08:00
<img src="doc/imgs_results/ch_ppocr_mobile_v2.0/test_add_91.jpg" width="800">
<img src="doc/imgs_results/ch_ppocr_mobile_v2.0/00018069.jpg" width="800">
2020-10-13 17:49:16 +08:00
</div>
上图是通用ppocr_server模型效果展示更多效果图请见[效果展示页面](./doc/doc_ch/visualization.md)。
2020-12-16 14:07:20 +08:00
<a name="欢迎加入PaddleOCR技术交流群"></a>
## 欢迎加入PaddleOCR技术交流群
- 微信扫描二维码加入官方交流群,获得更高效的问题答疑,与各行各业开发者充分交流,期待您的加入。
<div align="center">
2021-05-12 11:38:40 +08:00
<img src="https://raw.githubusercontent.com/PaddlePaddle/PaddleOCR/dygraph/doc/joinus.PNG" width = "200" height = "200" />
2020-12-16 14:07:20 +08:00
</div>
2020-10-13 17:49:16 +08:00
## 快速体验
- PC端超轻量级中文OCR在线体验地址https://www.paddlepaddle.org.cn/hub/scene/ocr
- 移动端:[安装包DEMO下载地址](https://ai.baidu.com/easyedge/app/openSource?from=paddlelite)(基于EasyEdge和Paddle-Lite, 支持iOS和Android系统)Android手机也可以直接扫描下面二维码安装体验。
<div align="center">
<img src="./doc/ocr-android-easyedge.png" width = "200" height = "200" />
</div>
2020-12-16 00:48:55 +08:00
- 代码体验:从[快速安装](./doc/doc_ch/quickstart.md) 开始
2020-10-13 17:49:16 +08:00
<a name="模型下载"></a>
2020-12-10 14:21:23 +08:00
## PP-OCR 2.0系列模型列表(更新中)
2020-12-16 11:02:50 +08:00
**说明** 2.0版模型和[1.1版模型](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/models_list.md)的主要区别在于动态图训练vs.静态图训练,模型性能上无明显差距。
2020-10-13 17:49:16 +08:00
| 模型简介 | 模型名称 |推荐场景 | 检测模型 | 方向分类器 | 识别模型 |
| ------------ | --------------- | ----------------|---- | ---------- | -------- |
2020-12-15 22:50:57 +08:00
| 中英文超轻量OCR模型9.4M | ch_ppocr_mobile_v2.0_xx |移动端&服务器端|[推理模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_det_infer.tar) / [预训练模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_det_train.tar)|[推理模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_cls_infer.tar) / [预训练模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_cls_train.tar) |[推理模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_rec_infer.tar) / [预训练模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_rec_pre.tar) |
| 中英文通用OCR模型143.4M |ch_ppocr_server_v2.0_xx|服务器端 |[推理模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_server_v2.0_det_infer.tar) / [预训练模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_server_v2.0_det_train.tar) |[推理模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_cls_infer.tar) / [预训练模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_mobile_v2.0_cls_train.tar) |[推理模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_server_v2.0_rec_infer.tar) / [预训练模型](https://paddleocr.bj.bcebos.com/dygraph_v2.0/ch/ch_ppocr_server_v2.0_rec_pre.tar) |
2020-10-13 17:49:16 +08:00
2020-12-11 17:50:01 +08:00
更多模型下载(包括多语言),可以参考[PP-OCR v2.0 系列模型下载](./doc/doc_ch/models_list.md)
2020-10-13 17:49:16 +08:00
## 文档教程
- [快速安装](./doc/doc_ch/installation.md)
- [中文OCR模型快速使用](./doc/doc_ch/quickstart.md)
2021-04-09 20:28:28 +08:00
- [多语言OCR模型快速使用](./doc/doc_ch/multi_languages.md)
2020-10-13 17:49:16 +08:00
- [代码组织结构](./doc/doc_ch/tree.md)
- 算法介绍
- [文本检测](./doc/doc_ch/algorithm_overview.md)
- [文本识别](./doc/doc_ch/algorithm_overview.md)
2021-04-29 17:03:59 +08:00
- [PP-OCR Pipeline](#PP-OCR)
2021-04-09 20:28:28 +08:00
- [端到端PGNet算法](./doc/doc_ch/pgnet.md)
2020-10-13 17:49:16 +08:00
- 模型训练/评估
- [文本检测](./doc/doc_ch/detection.md)
- [文本识别](./doc/doc_ch/recognition.md)
- [方向分类器](./doc/doc_ch/angle_class.md)
- [yml参数配置文件介绍](./doc/doc_ch/config.md)
- 预测部署
- [基于pip安装whl包快速推理](./doc/doc_ch/whl.md)
- [基于Python脚本预测引擎推理](./doc/doc_ch/inference.md)
- [基于C++预测引擎推理](./deploy/cpp_infer/readme.md)
2021-05-12 11:38:40 +08:00
- [服务化部署](./deploy/hubserving/readme.md)
2021-05-25 19:50:22 +08:00
- [端侧部署](./deploy/lite/readme.md)
2020-10-13 17:49:16 +08:00
- [Benchmark](./doc/doc_ch/benchmark.md)
- 数据集
- [通用中英文OCR数据集](./doc/doc_ch/datasets.md)
- [手写中文OCR数据集](./doc/doc_ch/handwritten_datasets.md)
- [垂类多语言OCR数据集](./doc/doc_ch/vertical_and_multilingual_datasets.md)
2020-12-15 22:37:52 +08:00
- 数据标注与合成
- [半自动标注工具PPOCRLabel](./PPOCRLabel/README_ch.md)
2020-12-16 00:51:26 +08:00
- [数据合成工具Style-Text](./StyleText/README_ch.md)
2020-12-15 22:50:57 +08:00
- [其它数据标注工具](./doc/doc_ch/data_annotation.md)
- [其它数据合成工具](./doc/doc_ch/data_synthesis.md)
2020-10-13 17:49:16 +08:00
- [效果展示](#效果展示)
- FAQ
- [【精选】OCR精选10个问题](./doc/doc_ch/FAQ.md)
2021-06-21 20:34:35 +08:00
- [【理论篇】OCR通用50个问题](./doc/doc_ch/FAQ.md)
- [【实战篇】PaddleOCR实战183个问题](./doc/doc_ch/FAQ.md)
2020-10-13 17:49:16 +08:00
- [技术交流群](#欢迎加入PaddleOCR技术交流群)
- [参考文献](./doc/doc_ch/reference.md)
- [许可证书](#许可证书)
- [贡献代码](#贡献代码)
2020-10-13 17:49:16 +08:00
<a name="PP-OCR"></a>
2021-04-29 17:03:59 +08:00
## PP-OCR Pipeline
2020-10-13 17:49:16 +08:00
<div align="center">
<img src="./doc/ppocr_framework.png" width="800">
</div>
2020-12-20 08:20:31 +08:00
PP-OCR是一个实用的超轻量OCR系统。主要由DB文本检测[2]、检测框矫正和CRNN文本识别三部分组成[7]。该系统从骨干网络选择和调整、预测头部的设计、数据增强、学习率变换策略、正则化参数选择、预训练模型使用以及模型自动裁剪量化8个方面采用19个有效策略对各个模块的模型进行效果调优和瘦身最终得到整体大小为3.5M的超轻量中英文OCR和2.8M的英文数字OCR。更多细节请参考PP-OCR技术方案 https://arxiv.org/abs/2009.09941 。其中FPGM裁剪器[8]和PACT量化[9]的实现可以参考[PaddleSlim](https://github.com/PaddlePaddle/PaddleSlim)。
2020-10-13 17:49:16 +08:00
<a name="效果展示"></a>
## 效果展示 [more](./doc/doc_ch/visualization.md)
- 中文模型
<div align="center">
2020-12-15 22:16:17 +08:00
<img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/test_add_91.jpg" width="800">
2020-12-15 22:14:29 +08:00
<img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/00015504.jpg" width="800">
<img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/00056221.jpg" width="800">
2020-12-15 15:08:23 +08:00
<img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/rotate_00052204.jpg" width="800">
2020-10-13 17:49:16 +08:00
</div>
- 英文模型
<div align="center">
2020-12-16 14:10:45 +08:00
<img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/img_12.jpg" width="800">
2020-10-13 17:49:16 +08:00
</div>
- 其他语言模型
<div align="center">
2020-12-15 16:14:38 +08:00
<img src="./doc/imgs_results/french_0.jpg" width="800">
2020-12-15 15:08:23 +08:00
<img src="./doc/imgs_results/korean.jpg" width="800">
2020-10-13 17:49:16 +08:00
</div>
<a name="许可证书"></a>
## 许可证书
本项目的发布受<a href="https://github.com/PaddlePaddle/PaddleOCR/blob/master/LICENSE">Apache 2.0 license</a>许可认证。
<a name="贡献代码"></a>
## 贡献代码
我们非常欢迎你为PaddleOCR贡献代码也十分感谢你的反馈。
2020-12-09 20:18:10 +08:00
2020-10-13 17:49:16 +08:00
- 非常感谢 [Khanh Tran](https://github.com/xxxpsyduck) 和 [Karl Horky](https://github.com/karlhorky) 贡献修改英文文档
2021-01-07 21:45:55 +08:00
- 非常感谢 [zhangxin](https://github.com/ZhangXinNan)([Blog](https://blog.csdn.net/sdlypyzq)) 贡献新的可视化方式、添加.gitignore、处理手动设置PYTHONPATH环境变量的问题
2020-10-13 17:49:16 +08:00
- 非常感谢 [lyl120117](https://github.com/lyl120117) 贡献打印网络结构的代码
- 非常感谢 [xiangyubo](https://github.com/xiangyubo) 贡献手写中文OCR数据集
- 非常感谢 [authorfu](https://github.com/authorfu) 贡献Android和[xiadeye](https://github.com/xiadeye) 贡献IOS的demo代码
- 非常感谢 [BeyondYourself](https://github.com/BeyondYourself) 给PaddleOCR提了很多非常棒的建议并简化了PaddleOCR的部分代码风格。
- 非常感谢 [tangmq](https://gitee.com/tangmq) 给PaddleOCR增加Docker化部署服务支持快速发布可调用的Restful API服务。
2020-12-09 20:18:10 +08:00
- 非常感谢 [lijinhan](https://github.com/lijinhan) 给PaddleOCR增加java SpringBoot 调用OCR Hubserving接口完成对OCR服务化部署的使用。
- 非常感谢 [Mejans](https://github.com/Mejans) 给PaddleOCR增加新语言奥克西坦语Occitan的字典和语料。
- 非常感谢 [Evezerest](https://github.com/Evezerest) [ninetailskim](https://github.com/ninetailskim) [edencfc](https://github.com/edencfc) [BeyondYourself](https://github.com/BeyondYourself) [1084667371](https://github.com/1084667371) 贡献了PPOCRLabel的完整代码。