diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-cnocr.spec | 693 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 695 insertions, 0 deletions
@@ -0,0 +1 @@ +/cnocr-2.2.2.3.tar.gz diff --git a/python-cnocr.spec b/python-cnocr.spec new file mode 100644 index 0000000..c980ff1 --- /dev/null +++ b/python-cnocr.spec @@ -0,0 +1,693 @@ +%global _empty_manifest_terminate_build 0 +Name: python-cnocr +Version: 2.2.2.3 +Release: 1 +Summary: Python3 package for Chinese/English OCR, with small pretrained models +License: Apache 2.0 +URL: https://github.com/breezedeus/cnocr +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/c5/dd/46c94aa92a5019aeb3c52a5e040ffbb264f49c93c70d0642bc29f4198919/cnocr-2.2.2.3.tar.gz +BuildArch: noarch + +Requires: python3-click +Requires: python3-tqdm +Requires: python3-torch +Requires: python3-torchvision +Requires: python3-numpy +Requires: python3-pytorch-lightning +Requires: python3-torchmetrics +Requires: python3-pillow +Requires: python3-onnx +Requires: python3-onnxruntime +Requires: python3-cnstd +Requires: python3-pip-tools +Requires: python3-pytest +Requires: python3-Levenshtein +Requires: python3-uvicorn[standard] +Requires: python3-fastapi +Requires: python3-multipart +Requires: python3-pydantic + +%description +</div> +[**CnOCR**](https://github.com/breezedeus/cnocr) 是 **Python 3** 下的**文字识别**（**Optical Character Recognition**，简称**OCR**）工具包，支持**简体中文**、**繁体中文**（部分模型）、**英文**和**数字**的常见字符识别，支持竖排文字的识别。自带了**20+个** [训练好的模型](https://cnocr.readthedocs.io/zh/latest/models/)，适用于不同应用场景，安装后即可直接使用。同时，CnOCR也提供简单的[训练命令](https://cnocr.readthedocs.io/zh/latest/train/)供使用者训练自己的模型。欢迎扫码加小助手为好友，备注 `ocr`，小助手会定期统一邀请大家入群： +<div align="center"> + <img src="https://huggingface.co/datasets/breezedeus/cnocr-wx-qr-code/resolve/main/wx-qr-code.JPG" alt="微信群二维码" width="300px"/> +</div> +作者也维护 **知识星球** [**CnOCR/CnSTD私享群**](https://t.zsxq.com/FEYZRJQ) ，这里面的提问会较快得到作者的回复，欢迎加入。**知识星球私享群**也会陆续发布一些CnOCR/CnSTD相关的私有资料，包括[**更详细的训练教程**](https://articles.zsxq.com/id_u6b4u0wrf46e.html)，**未公开的模型**，**不同应用场景的调用代码**，使用过程中遇到的难题解答等。本群也会发布OCR/STD相关的最新研究资料。此外，**私享群中作者每月提供两次免费特有数据的训练服务**。 +## 详细文档 +见 [CnOCR在线文档](https://cnocr.readthedocs.io/) 。 +## 使用说明 +**CnOCR** 从 **V2.2** 开始，内部自动调用文字检测引擎 **[CnSTD](https://github.com/breezedeus/cnstd)** 进行文字检测和定位。所以 **CnOCR** V2.2 不仅能识别排版简单的印刷体文字图片，如截图图片，扫描件等，也能识别**一般图片中的场景文字**。 +以下是一些不同场景的调用示例。 +## 在 Cloud IDE 中预览 +[https://idegithub.com/breezedeus/CnOCR](https://idegithub.com/breezedeus/CnOCR) +## 不同场景的调用示例 +### 常见的图片识别 +所有参数都使用默认值即可。如果发现效果不够好，多调整下各个参数看效果，最终往往能获得比较理想的精度。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/huochepiao.jpeg' +ocr = CnOcr() # 所有参数都使用默认值 +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/huochepiao.jpeg-result.jpg" alt="火车票识别" width="800px"/> +</div> +### 排版简单的印刷体截图图片识别 +针对 **排版简单的印刷体文字图片**，如截图图片，扫描件图片等，可使用 `det_model_name='naive_det'`，相当于不使用文本检测模型，而使用简单的规则进行分行。 +> **Note** +> +> `det_model_name='naive_det'` 的效果相当于 `V2.2` 之前（`V2.0.*`, `V2.1.*`）的 CnOCR 版本。 +使用 `det_model_name='naive_det'` 的最大优势是**速度快**，劣势是对图片比较挑剔。如何判断是否该使用此检测模型呢？最简单的方式就是拿应用图片试试效果，效果好就用，不好就不用。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/multi-line_cn1.png' +ocr = CnOcr(det_model_name='naive_det') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> +| 图片 | OCR结果 | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +|  | 网络支付并无本质的区别，因为<br />每一个手机号码和邮件地址背后<br />都会对应着一个账户--这个账<br />户可以是信用卡账户、借记卡账<br />户，也包括邮局汇款、手机代<br />收、电话代收、预付费卡和点卡<br />等多种形式。 | +</div> +### 竖排文字识别 +采用来自 [**PaddleOCR**](https://github.com/PaddlePaddle/PaddleOCR)（之后简称 **ppocr**）的中文识别模型 `rec_model_name='ch_PP-OCRv3'` 进行识别。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/shupai.png' +ocr = CnOcr(rec_model_name='ch_PP-OCRv3') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/shupai.png-result.jpg" alt="竖排文字识别" width="800px"/> +</div> +### 英文识别 +虽然中文检测和识别模型也能识别英文，但**专为英文文字训练的检测器和识别器往往精度更高**。如果是纯英文的应用场景，建议使用来自 **ppocr** 的英文检测模型 `det_model_name='en_PP-OCRv3_det'`， 和英文识别模型 `rec_model_name='en_PP-OCRv3'` 。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/en_book1.jpeg' +ocr = CnOcr(det_model_name='en_PP-OCRv3_det', rec_model_name='en_PP-OCRv3') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/en_book1.jpeg-result.jpg" alt="英文识别" width="600px"/> +</div> +### 繁体中文识别 +采用来自ppocr的繁体识别模型 `rec_model_name='chinese_cht_PP-OCRv3'` 进行识别。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/fanti.jpg' +ocr = CnOcr(rec_model_name='chinese_cht_PP-OCRv3') # 识别模型使用繁体识别模型 +out = ocr.ocr(img_fp) +print(out) +``` +使用此模型时请注意以下问题： +* 识别精度一般，不是很好； +* 除了繁体字，对标点、英文、数字的识别都不好； +* 此模型不支持竖排文字的识别。 +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/fanti.jpg-result.jpg" alt="繁体中文识别" width="700px"/> +</div> +### 单行文字的图片识别 +如果明确知道待识别的图片是单行文字图片（如下图），可以使用类函数 `CnOcr.ocr_for_single_line()` 进行识别。这样就省掉了文字检测的时间，速度会快一倍以上。 +<div align="center"> + <img src="./docs/examples/helloworld.jpg" alt="单行文本识别" width="300px"/> +</div> +调用代码如下： +```python +from cnocr import CnOcr +img_fp = './docs/examples/helloworld.jpg' +ocr = CnOcr() +out = ocr.ocr_for_single_line(img_fp) +print(out) +``` +### 更多应用示例 +* **核酸疫苗截图识别** +<div align="center"> + <img src="./docs/predict-outputs/jiankangbao.jpeg-result.jpg" alt="核酸疫苗截图识别" width="500px"/> +</div> +* **身份证识别** +<div align="center"> + <img src="./docs/predict-outputs/aobama.webp-result.jpg" alt="身份证识别" width="700px"/> +</div> +* **饭店小票识别** +<div align="center"> + <img src="./docs/predict-outputs/fapiao.jpeg-result.jpg" alt="饭店小票识别" width="500px"/> +</div> +## 安装 +嗯，顺利的话一行命令即可。 +```bash +pip install cnocr +``` +安装速度慢的话，可以指定国内的安装源，如使用豆瓣源： +```bash +pip install cnocr -i https://pypi.doubanio.com/simple +``` +> **Note** +> +> 请使用 **Python3**（3.6以及之后版本应该都行），没测过Python2下是否ok。 +更多说明可见 [安装文档](https://cnocr.readthedocs.io/zh/latest/install/)。 +> **Warning** +> +> 如果电脑中从未安装过 `PyTorch`，`OpenCV` python包，初次安装可能会遇到问题，但一般都是常见问题，可以自行百度/Google解决。 +## HTTP服务 +CnOCR **V2.2.1** 加入了基于 FastAPI 的HTTP服务。开启服务需要安装几个额外的包，可以使用以下命令安装： +```bash +pip install cnocr[serve] +``` +安装完成后，可以通过以下命令启动HTTP服务（**`-p`** 后面的数字是**端口**，可以根据需要自行调整）： +```bash +cnocr serve -p 8501 +``` +服务开启后，可以使用以下方式调用服务。 +### 命令行 +比如待识别文件为 `docs/examples/huochepiao.jpeg`，如下使用 curl 调用服务： +```bash +> curl -F image=@docs/examples/huochepiao.jpeg http://0.0.0.0:8501/ocr +``` +### Python +使用如下方式调用服务： +```python +import requests +image_fp = 'docs/examples/huochepiao.jpeg' +r = requests.post( + 'http://0.0.0.0:8501/ocr', files={'image': (image_fp, open(image_fp, 'rb'), 'image/png')}, +) +ocr_out = r.json()['results'] +print(ocr_out) +``` +具体也可参考文件 [scripts/screenshot_daemon_with_server.py](scripts/screenshot_daemon_with_server.py) 。 +### 其他语言 +请参照 curl 的调用方式自行实现。 +## 可使用的模型 +### 可使用的检测模型 +| `det_model_name` | PyTorch 版本 | ONNX 版本 | 模型原始来源 | 模型文件大小 | 支持语言 | 是否支持竖排文字识别 | +| ------------------------------------------------------------ | ------------ | --------- | ------------ | ------------ | ------------------------------ | -------------------- | +| db_shufflenet_v2 | √ | X | cnocr | 18 M | 简体中文、繁体中文、英文、数字 | √ | +| **db_shufflenet_v2_small** | √ | X | cnocr | 12 M | 简体中文、繁体中文、英文、数字 | √ | +| [db_shufflenet_v2_tiny](https://mp.weixin.qq.com/s/fHPNoGyo72EFApVhEgR6Nw) | √ | X | cnocr | 7.5 M | 简体中文、繁体中文、英文、数字 | √ | +| db_mobilenet_v3 | √ | X | cnocr | 16 M | 简体中文、繁体中文、英文、数字 | √ | +| db_mobilenet_v3_small | √ | X | cnocr | 7.9 M | 简体中文、繁体中文、英文、数字 | √ | +| db_resnet34 | √ | X | cnocr | 86 M | 简体中文、繁体中文、英文、数字 | √ | +| db_resnet18 | √ | X | cnocr | 47 M | 简体中文、繁体中文、英文、数字 | √ | +| ch_PP-OCRv3_det | X | √ | ppocr | 2.3 M | 简体中文、繁体中文、英文、数字 | √ | +| ch_PP-OCRv2_det | X | √ | ppocr | 2.2 M | 简体中文、繁体中文、英文、数字 | √ | +| **en_PP-OCRv3_det** | X | √ | ppocr | 2.3 M | **英文**、数字 | √ | +### 可使用的识别模型 +| `rec_model_name` | PyTorch 版本 | ONNX 版本 | 模型原始来源 | 模型文件大小 | 支持语言 | 是否支持竖排文字识别 | +| ------------------------- | ------------ | --------- | ------------ | ------------ | ------------------------ | -------------------- | +| densenet_lite_114-fc | √ | √ | cnocr | 4.9 M | 简体中文、英文、数字 | X | +| densenet_lite_124-fc | √ | √ | cnocr | 5.1 M | 简体中文、英文、数字 | X | +| densenet_lite_134-fc | √ | √ | cnocr | 5.4 M | 简体中文、英文、数字 | X | +| densenet_lite_136-fc | √ | √ | cnocr | 5.9 M | 简体中文、英文、数字 | X | +| densenet_lite_134-gru | √ | X | cnocr | 11 M | 简体中文、英文、数字 | X | +| densenet_lite_136-gru | √ | X | cnocr | 12 M | 简体中文、英文、数字 | X | +| ch_PP-OCRv3 | X | √ | ppocr | 10 M | 简体中文、英文、数字 | √ | +| ch_ppocr_mobile_v2.0 | X | √ | ppocr | 4.2 M | 简体中文、英文、数字 | √ | +| **en_PP-OCRv3** | X | √ | ppocr | 8.5 M | **英文**、数字 | √ | +| **en_number_mobile_v2.0** | X | √ | ppocr | 1.8 M | **英文**、数字 | √ | +| **chinese_cht_PP-OCRv3** | X | √ | ppocr | 11 M | **繁体中文**、英文、数字 | X | +## 未来工作 +* [x] 支持图片包含多行文字 (`Done`) +* [x] crnn模型支持可变长预测，提升灵活性 (since `V1.0.0`) +* [x] 完善测试用例 (`Doing`) +* [x] 修bugs（目前代码还比较凌乱。。） (`Doing`) +* [x] 支持`空格`识别（since `V1.1.0`） +* [x] 尝试新模型，如 DenseNet，进一步提升识别准确率（since `V1.1.0`） +* [x] 优化训练集，去掉不合理的样本；在此基础上，重新训练各个模型 +* [x] 由 MXNet 改为 PyTorch 架构（since `V2.0.0`） +* [x] 基于 PyTorch 训练更高效的模型 +* [x] 支持列格式的文字识别 +* [x] 打通与 [CnSTD](https://github.com/breezedeus/cnstd) 的无缝衔接（since `V2.2`） +* [ ] 支持更多的应用场景，如公式识别、表格识别、版面分析等 +## 给作者来杯咖啡 + +%package -n python3-cnocr +Summary: Python3 package for Chinese/English OCR, with small pretrained models +Provides: python-cnocr +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-cnocr +</div> +[**CnOCR**](https://github.com/breezedeus/cnocr) 是 **Python 3** 下的**文字识别**（**Optical Character Recognition**，简称**OCR**）工具包，支持**简体中文**、**繁体中文**（部分模型）、**英文**和**数字**的常见字符识别，支持竖排文字的识别。自带了**20+个** [训练好的模型](https://cnocr.readthedocs.io/zh/latest/models/)，适用于不同应用场景，安装后即可直接使用。同时，CnOCR也提供简单的[训练命令](https://cnocr.readthedocs.io/zh/latest/train/)供使用者训练自己的模型。欢迎扫码加小助手为好友，备注 `ocr`，小助手会定期统一邀请大家入群： +<div align="center"> + <img src="https://huggingface.co/datasets/breezedeus/cnocr-wx-qr-code/resolve/main/wx-qr-code.JPG" alt="微信群二维码" width="300px"/> +</div> +作者也维护 **知识星球** [**CnOCR/CnSTD私享群**](https://t.zsxq.com/FEYZRJQ) ，这里面的提问会较快得到作者的回复，欢迎加入。**知识星球私享群**也会陆续发布一些CnOCR/CnSTD相关的私有资料，包括[**更详细的训练教程**](https://articles.zsxq.com/id_u6b4u0wrf46e.html)，**未公开的模型**，**不同应用场景的调用代码**，使用过程中遇到的难题解答等。本群也会发布OCR/STD相关的最新研究资料。此外，**私享群中作者每月提供两次免费特有数据的训练服务**。 +## 详细文档 +见 [CnOCR在线文档](https://cnocr.readthedocs.io/) 。 +## 使用说明 +**CnOCR** 从 **V2.2** 开始，内部自动调用文字检测引擎 **[CnSTD](https://github.com/breezedeus/cnstd)** 进行文字检测和定位。所以 **CnOCR** V2.2 不仅能识别排版简单的印刷体文字图片，如截图图片，扫描件等，也能识别**一般图片中的场景文字**。 +以下是一些不同场景的调用示例。 +## 在 Cloud IDE 中预览 +[https://idegithub.com/breezedeus/CnOCR](https://idegithub.com/breezedeus/CnOCR) +## 不同场景的调用示例 +### 常见的图片识别 +所有参数都使用默认值即可。如果发现效果不够好，多调整下各个参数看效果，最终往往能获得比较理想的精度。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/huochepiao.jpeg' +ocr = CnOcr() # 所有参数都使用默认值 +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/huochepiao.jpeg-result.jpg" alt="火车票识别" width="800px"/> +</div> +### 排版简单的印刷体截图图片识别 +针对 **排版简单的印刷体文字图片**，如截图图片，扫描件图片等，可使用 `det_model_name='naive_det'`，相当于不使用文本检测模型，而使用简单的规则进行分行。 +> **Note** +> +> `det_model_name='naive_det'` 的效果相当于 `V2.2` 之前（`V2.0.*`, `V2.1.*`）的 CnOCR 版本。 +使用 `det_model_name='naive_det'` 的最大优势是**速度快**，劣势是对图片比较挑剔。如何判断是否该使用此检测模型呢？最简单的方式就是拿应用图片试试效果，效果好就用，不好就不用。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/multi-line_cn1.png' +ocr = CnOcr(det_model_name='naive_det') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> +| 图片 | OCR结果 | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +|  | 网络支付并无本质的区别，因为<br />每一个手机号码和邮件地址背后<br />都会对应着一个账户--这个账<br />户可以是信用卡账户、借记卡账<br />户，也包括邮局汇款、手机代<br />收、电话代收、预付费卡和点卡<br />等多种形式。 | +</div> +### 竖排文字识别 +采用来自 [**PaddleOCR**](https://github.com/PaddlePaddle/PaddleOCR)（之后简称 **ppocr**）的中文识别模型 `rec_model_name='ch_PP-OCRv3'` 进行识别。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/shupai.png' +ocr = CnOcr(rec_model_name='ch_PP-OCRv3') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/shupai.png-result.jpg" alt="竖排文字识别" width="800px"/> +</div> +### 英文识别 +虽然中文检测和识别模型也能识别英文，但**专为英文文字训练的检测器和识别器往往精度更高**。如果是纯英文的应用场景，建议使用来自 **ppocr** 的英文检测模型 `det_model_name='en_PP-OCRv3_det'`， 和英文识别模型 `rec_model_name='en_PP-OCRv3'` 。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/en_book1.jpeg' +ocr = CnOcr(det_model_name='en_PP-OCRv3_det', rec_model_name='en_PP-OCRv3') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/en_book1.jpeg-result.jpg" alt="英文识别" width="600px"/> +</div> +### 繁体中文识别 +采用来自ppocr的繁体识别模型 `rec_model_name='chinese_cht_PP-OCRv3'` 进行识别。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/fanti.jpg' +ocr = CnOcr(rec_model_name='chinese_cht_PP-OCRv3') # 识别模型使用繁体识别模型 +out = ocr.ocr(img_fp) +print(out) +``` +使用此模型时请注意以下问题： +* 识别精度一般，不是很好； +* 除了繁体字，对标点、英文、数字的识别都不好； +* 此模型不支持竖排文字的识别。 +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/fanti.jpg-result.jpg" alt="繁体中文识别" width="700px"/> +</div> +### 单行文字的图片识别 +如果明确知道待识别的图片是单行文字图片（如下图），可以使用类函数 `CnOcr.ocr_for_single_line()` 进行识别。这样就省掉了文字检测的时间，速度会快一倍以上。 +<div align="center"> + <img src="./docs/examples/helloworld.jpg" alt="单行文本识别" width="300px"/> +</div> +调用代码如下： +```python +from cnocr import CnOcr +img_fp = './docs/examples/helloworld.jpg' +ocr = CnOcr() +out = ocr.ocr_for_single_line(img_fp) +print(out) +``` +### 更多应用示例 +* **核酸疫苗截图识别** +<div align="center"> + <img src="./docs/predict-outputs/jiankangbao.jpeg-result.jpg" alt="核酸疫苗截图识别" width="500px"/> +</div> +* **身份证识别** +<div align="center"> + <img src="./docs/predict-outputs/aobama.webp-result.jpg" alt="身份证识别" width="700px"/> +</div> +* **饭店小票识别** +<div align="center"> + <img src="./docs/predict-outputs/fapiao.jpeg-result.jpg" alt="饭店小票识别" width="500px"/> +</div> +## 安装 +嗯，顺利的话一行命令即可。 +```bash +pip install cnocr +``` +安装速度慢的话，可以指定国内的安装源，如使用豆瓣源： +```bash +pip install cnocr -i https://pypi.doubanio.com/simple +``` +> **Note** +> +> 请使用 **Python3**（3.6以及之后版本应该都行），没测过Python2下是否ok。 +更多说明可见 [安装文档](https://cnocr.readthedocs.io/zh/latest/install/)。 +> **Warning** +> +> 如果电脑中从未安装过 `PyTorch`，`OpenCV` python包，初次安装可能会遇到问题，但一般都是常见问题，可以自行百度/Google解决。 +## HTTP服务 +CnOCR **V2.2.1** 加入了基于 FastAPI 的HTTP服务。开启服务需要安装几个额外的包，可以使用以下命令安装： +```bash +pip install cnocr[serve] +``` +安装完成后，可以通过以下命令启动HTTP服务（**`-p`** 后面的数字是**端口**，可以根据需要自行调整）： +```bash +cnocr serve -p 8501 +``` +服务开启后，可以使用以下方式调用服务。 +### 命令行 +比如待识别文件为 `docs/examples/huochepiao.jpeg`，如下使用 curl 调用服务： +```bash +> curl -F image=@docs/examples/huochepiao.jpeg http://0.0.0.0:8501/ocr +``` +### Python +使用如下方式调用服务： +```python +import requests +image_fp = 'docs/examples/huochepiao.jpeg' +r = requests.post( + 'http://0.0.0.0:8501/ocr', files={'image': (image_fp, open(image_fp, 'rb'), 'image/png')}, +) +ocr_out = r.json()['results'] +print(ocr_out) +``` +具体也可参考文件 [scripts/screenshot_daemon_with_server.py](scripts/screenshot_daemon_with_server.py) 。 +### 其他语言 +请参照 curl 的调用方式自行实现。 +## 可使用的模型 +### 可使用的检测模型 +| `det_model_name` | PyTorch 版本 | ONNX 版本 | 模型原始来源 | 模型文件大小 | 支持语言 | 是否支持竖排文字识别 | +| ------------------------------------------------------------ | ------------ | --------- | ------------ | ------------ | ------------------------------ | -------------------- | +| db_shufflenet_v2 | √ | X | cnocr | 18 M | 简体中文、繁体中文、英文、数字 | √ | +| **db_shufflenet_v2_small** | √ | X | cnocr | 12 M | 简体中文、繁体中文、英文、数字 | √ | +| [db_shufflenet_v2_tiny](https://mp.weixin.qq.com/s/fHPNoGyo72EFApVhEgR6Nw) | √ | X | cnocr | 7.5 M | 简体中文、繁体中文、英文、数字 | √ | +| db_mobilenet_v3 | √ | X | cnocr | 16 M | 简体中文、繁体中文、英文、数字 | √ | +| db_mobilenet_v3_small | √ | X | cnocr | 7.9 M | 简体中文、繁体中文、英文、数字 | √ | +| db_resnet34 | √ | X | cnocr | 86 M | 简体中文、繁体中文、英文、数字 | √ | +| db_resnet18 | √ | X | cnocr | 47 M | 简体中文、繁体中文、英文、数字 | √ | +| ch_PP-OCRv3_det | X | √ | ppocr | 2.3 M | 简体中文、繁体中文、英文、数字 | √ | +| ch_PP-OCRv2_det | X | √ | ppocr | 2.2 M | 简体中文、繁体中文、英文、数字 | √ | +| **en_PP-OCRv3_det** | X | √ | ppocr | 2.3 M | **英文**、数字 | √ | +### 可使用的识别模型 +| `rec_model_name` | PyTorch 版本 | ONNX 版本 | 模型原始来源 | 模型文件大小 | 支持语言 | 是否支持竖排文字识别 | +| ------------------------- | ------------ | --------- | ------------ | ------------ | ------------------------ | -------------------- | +| densenet_lite_114-fc | √ | √ | cnocr | 4.9 M | 简体中文、英文、数字 | X | +| densenet_lite_124-fc | √ | √ | cnocr | 5.1 M | 简体中文、英文、数字 | X | +| densenet_lite_134-fc | √ | √ | cnocr | 5.4 M | 简体中文、英文、数字 | X | +| densenet_lite_136-fc | √ | √ | cnocr | 5.9 M | 简体中文、英文、数字 | X | +| densenet_lite_134-gru | √ | X | cnocr | 11 M | 简体中文、英文、数字 | X | +| densenet_lite_136-gru | √ | X | cnocr | 12 M | 简体中文、英文、数字 | X | +| ch_PP-OCRv3 | X | √ | ppocr | 10 M | 简体中文、英文、数字 | √ | +| ch_ppocr_mobile_v2.0 | X | √ | ppocr | 4.2 M | 简体中文、英文、数字 | √ | +| **en_PP-OCRv3** | X | √ | ppocr | 8.5 M | **英文**、数字 | √ | +| **en_number_mobile_v2.0** | X | √ | ppocr | 1.8 M | **英文**、数字 | √ | +| **chinese_cht_PP-OCRv3** | X | √ | ppocr | 11 M | **繁体中文**、英文、数字 | X | +## 未来工作 +* [x] 支持图片包含多行文字 (`Done`) +* [x] crnn模型支持可变长预测，提升灵活性 (since `V1.0.0`) +* [x] 完善测试用例 (`Doing`) +* [x] 修bugs（目前代码还比较凌乱。。） (`Doing`) +* [x] 支持`空格`识别（since `V1.1.0`） +* [x] 尝试新模型，如 DenseNet，进一步提升识别准确率（since `V1.1.0`） +* [x] 优化训练集，去掉不合理的样本；在此基础上，重新训练各个模型 +* [x] 由 MXNet 改为 PyTorch 架构（since `V2.0.0`） +* [x] 基于 PyTorch 训练更高效的模型 +* [x] 支持列格式的文字识别 +* [x] 打通与 [CnSTD](https://github.com/breezedeus/cnstd) 的无缝衔接（since `V2.2`） +* [ ] 支持更多的应用场景，如公式识别、表格识别、版面分析等 +## 给作者来杯咖啡 + +%package help +Summary: Development documents and examples for cnocr +Provides: python3-cnocr-doc +%description help +</div> +[**CnOCR**](https://github.com/breezedeus/cnocr) 是 **Python 3** 下的**文字识别**（**Optical Character Recognition**，简称**OCR**）工具包，支持**简体中文**、**繁体中文**（部分模型）、**英文**和**数字**的常见字符识别，支持竖排文字的识别。自带了**20+个** [训练好的模型](https://cnocr.readthedocs.io/zh/latest/models/)，适用于不同应用场景，安装后即可直接使用。同时，CnOCR也提供简单的[训练命令](https://cnocr.readthedocs.io/zh/latest/train/)供使用者训练自己的模型。欢迎扫码加小助手为好友，备注 `ocr`，小助手会定期统一邀请大家入群： +<div align="center"> + <img src="https://huggingface.co/datasets/breezedeus/cnocr-wx-qr-code/resolve/main/wx-qr-code.JPG" alt="微信群二维码" width="300px"/> +</div> +作者也维护 **知识星球** [**CnOCR/CnSTD私享群**](https://t.zsxq.com/FEYZRJQ) ，这里面的提问会较快得到作者的回复，欢迎加入。**知识星球私享群**也会陆续发布一些CnOCR/CnSTD相关的私有资料，包括[**更详细的训练教程**](https://articles.zsxq.com/id_u6b4u0wrf46e.html)，**未公开的模型**，**不同应用场景的调用代码**，使用过程中遇到的难题解答等。本群也会发布OCR/STD相关的最新研究资料。此外，**私享群中作者每月提供两次免费特有数据的训练服务**。 +## 详细文档 +见 [CnOCR在线文档](https://cnocr.readthedocs.io/) 。 +## 使用说明 +**CnOCR** 从 **V2.2** 开始，内部自动调用文字检测引擎 **[CnSTD](https://github.com/breezedeus/cnstd)** 进行文字检测和定位。所以 **CnOCR** V2.2 不仅能识别排版简单的印刷体文字图片，如截图图片，扫描件等，也能识别**一般图片中的场景文字**。 +以下是一些不同场景的调用示例。 +## 在 Cloud IDE 中预览 +[https://idegithub.com/breezedeus/CnOCR](https://idegithub.com/breezedeus/CnOCR) +## 不同场景的调用示例 +### 常见的图片识别 +所有参数都使用默认值即可。如果发现效果不够好，多调整下各个参数看效果，最终往往能获得比较理想的精度。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/huochepiao.jpeg' +ocr = CnOcr() # 所有参数都使用默认值 +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/huochepiao.jpeg-result.jpg" alt="火车票识别" width="800px"/> +</div> +### 排版简单的印刷体截图图片识别 +针对 **排版简单的印刷体文字图片**，如截图图片，扫描件图片等，可使用 `det_model_name='naive_det'`，相当于不使用文本检测模型，而使用简单的规则进行分行。 +> **Note** +> +> `det_model_name='naive_det'` 的效果相当于 `V2.2` 之前（`V2.0.*`, `V2.1.*`）的 CnOCR 版本。 +使用 `det_model_name='naive_det'` 的最大优势是**速度快**，劣势是对图片比较挑剔。如何判断是否该使用此检测模型呢？最简单的方式就是拿应用图片试试效果，效果好就用，不好就不用。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/multi-line_cn1.png' +ocr = CnOcr(det_model_name='naive_det') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> +| 图片 | OCR结果 | +| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +|  | 网络支付并无本质的区别，因为<br />每一个手机号码和邮件地址背后<br />都会对应着一个账户--这个账<br />户可以是信用卡账户、借记卡账<br />户，也包括邮局汇款、手机代<br />收、电话代收、预付费卡和点卡<br />等多种形式。 | +</div> +### 竖排文字识别 +采用来自 [**PaddleOCR**](https://github.com/PaddlePaddle/PaddleOCR)（之后简称 **ppocr**）的中文识别模型 `rec_model_name='ch_PP-OCRv3'` 进行识别。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/shupai.png' +ocr = CnOcr(rec_model_name='ch_PP-OCRv3') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/shupai.png-result.jpg" alt="竖排文字识别" width="800px"/> +</div> +### 英文识别 +虽然中文检测和识别模型也能识别英文，但**专为英文文字训练的检测器和识别器往往精度更高**。如果是纯英文的应用场景，建议使用来自 **ppocr** 的英文检测模型 `det_model_name='en_PP-OCRv3_det'`， 和英文识别模型 `rec_model_name='en_PP-OCRv3'` 。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/en_book1.jpeg' +ocr = CnOcr(det_model_name='en_PP-OCRv3_det', rec_model_name='en_PP-OCRv3') +out = ocr.ocr(img_fp) +print(out) +``` +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/en_book1.jpeg-result.jpg" alt="英文识别" width="600px"/> +</div> +### 繁体中文识别 +采用来自ppocr的繁体识别模型 `rec_model_name='chinese_cht_PP-OCRv3'` 进行识别。 +```python +from cnocr import CnOcr +img_fp = './docs/examples/fanti.jpg' +ocr = CnOcr(rec_model_name='chinese_cht_PP-OCRv3') # 识别模型使用繁体识别模型 +out = ocr.ocr(img_fp) +print(out) +``` +使用此模型时请注意以下问题： +* 识别精度一般，不是很好； +* 除了繁体字，对标点、英文、数字的识别都不好； +* 此模型不支持竖排文字的识别。 +识别结果： +<div align="center"> + <img src="./docs/predict-outputs/fanti.jpg-result.jpg" alt="繁体中文识别" width="700px"/> +</div> +### 单行文字的图片识别 +如果明确知道待识别的图片是单行文字图片（如下图），可以使用类函数 `CnOcr.ocr_for_single_line()` 进行识别。这样就省掉了文字检测的时间，速度会快一倍以上。 +<div align="center"> + <img src="./docs/examples/helloworld.jpg" alt="单行文本识别" width="300px"/> +</div> +调用代码如下： +```python +from cnocr import CnOcr +img_fp = './docs/examples/helloworld.jpg' +ocr = CnOcr() +out = ocr.ocr_for_single_line(img_fp) +print(out) +``` +### 更多应用示例 +* **核酸疫苗截图识别** +<div align="center"> + <img src="./docs/predict-outputs/jiankangbao.jpeg-result.jpg" alt="核酸疫苗截图识别" width="500px"/> +</div> +* **身份证识别** +<div align="center"> + <img src="./docs/predict-outputs/aobama.webp-result.jpg" alt="身份证识别" width="700px"/> +</div> +* **饭店小票识别** +<div align="center"> + <img src="./docs/predict-outputs/fapiao.jpeg-result.jpg" alt="饭店小票识别" width="500px"/> +</div> +## 安装 +嗯，顺利的话一行命令即可。 +```bash +pip install cnocr +``` +安装速度慢的话，可以指定国内的安装源，如使用豆瓣源： +```bash +pip install cnocr -i https://pypi.doubanio.com/simple +``` +> **Note** +> +> 请使用 **Python3**（3.6以及之后版本应该都行），没测过Python2下是否ok。 +更多说明可见 [安装文档](https://cnocr.readthedocs.io/zh/latest/install/)。 +> **Warning** +> +> 如果电脑中从未安装过 `PyTorch`，`OpenCV` python包，初次安装可能会遇到问题，但一般都是常见问题，可以自行百度/Google解决。 +## HTTP服务 +CnOCR **V2.2.1** 加入了基于 FastAPI 的HTTP服务。开启服务需要安装几个额外的包，可以使用以下命令安装： +```bash +pip install cnocr[serve] +``` +安装完成后，可以通过以下命令启动HTTP服务（**`-p`** 后面的数字是**端口**，可以根据需要自行调整）： +```bash +cnocr serve -p 8501 +``` +服务开启后，可以使用以下方式调用服务。 +### 命令行 +比如待识别文件为 `docs/examples/huochepiao.jpeg`，如下使用 curl 调用服务： +```bash +> curl -F image=@docs/examples/huochepiao.jpeg http://0.0.0.0:8501/ocr +``` +### Python +使用如下方式调用服务： +```python +import requests +image_fp = 'docs/examples/huochepiao.jpeg' +r = requests.post( + 'http://0.0.0.0:8501/ocr', files={'image': (image_fp, open(image_fp, 'rb'), 'image/png')}, +) +ocr_out = r.json()['results'] +print(ocr_out) +``` +具体也可参考文件 [scripts/screenshot_daemon_with_server.py](scripts/screenshot_daemon_with_server.py) 。 +### 其他语言 +请参照 curl 的调用方式自行实现。 +## 可使用的模型 +### 可使用的检测模型 +| `det_model_name` | PyTorch 版本 | ONNX 版本 | 模型原始来源 | 模型文件大小 | 支持语言 | 是否支持竖排文字识别 | +| ------------------------------------------------------------ | ------------ | --------- | ------------ | ------------ | ------------------------------ | -------------------- | +| db_shufflenet_v2 | √ | X | cnocr | 18 M | 简体中文、繁体中文、英文、数字 | √ | +| **db_shufflenet_v2_small** | √ | X | cnocr | 12 M | 简体中文、繁体中文、英文、数字 | √ | +| [db_shufflenet_v2_tiny](https://mp.weixin.qq.com/s/fHPNoGyo72EFApVhEgR6Nw) | √ | X | cnocr | 7.5 M | 简体中文、繁体中文、英文、数字 | √ | +| db_mobilenet_v3 | √ | X | cnocr | 16 M | 简体中文、繁体中文、英文、数字 | √ | +| db_mobilenet_v3_small | √ | X | cnocr | 7.9 M | 简体中文、繁体中文、英文、数字 | √ | +| db_resnet34 | √ | X | cnocr | 86 M | 简体中文、繁体中文、英文、数字 | √ | +| db_resnet18 | √ | X | cnocr | 47 M | 简体中文、繁体中文、英文、数字 | √ | +| ch_PP-OCRv3_det | X | √ | ppocr | 2.3 M | 简体中文、繁体中文、英文、数字 | √ | +| ch_PP-OCRv2_det | X | √ | ppocr | 2.2 M | 简体中文、繁体中文、英文、数字 | √ | +| **en_PP-OCRv3_det** | X | √ | ppocr | 2.3 M | **英文**、数字 | √ | +### 可使用的识别模型 +| `rec_model_name` | PyTorch 版本 | ONNX 版本 | 模型原始来源 | 模型文件大小 | 支持语言 | 是否支持竖排文字识别 | +| ------------------------- | ------------ | --------- | ------------ | ------------ | ------------------------ | -------------------- | +| densenet_lite_114-fc | √ | √ | cnocr | 4.9 M | 简体中文、英文、数字 | X | +| densenet_lite_124-fc | √ | √ | cnocr | 5.1 M | 简体中文、英文、数字 | X | +| densenet_lite_134-fc | √ | √ | cnocr | 5.4 M | 简体中文、英文、数字 | X | +| densenet_lite_136-fc | √ | √ | cnocr | 5.9 M | 简体中文、英文、数字 | X | +| densenet_lite_134-gru | √ | X | cnocr | 11 M | 简体中文、英文、数字 | X | +| densenet_lite_136-gru | √ | X | cnocr | 12 M | 简体中文、英文、数字 | X | +| ch_PP-OCRv3 | X | √ | ppocr | 10 M | 简体中文、英文、数字 | √ | +| ch_ppocr_mobile_v2.0 | X | √ | ppocr | 4.2 M | 简体中文、英文、数字 | √ | +| **en_PP-OCRv3** | X | √ | ppocr | 8.5 M | **英文**、数字 | √ | +| **en_number_mobile_v2.0** | X | √ | ppocr | 1.8 M | **英文**、数字 | √ | +| **chinese_cht_PP-OCRv3** | X | √ | ppocr | 11 M | **繁体中文**、英文、数字 | X | +## 未来工作 +* [x] 支持图片包含多行文字 (`Done`) +* [x] crnn模型支持可变长预测，提升灵活性 (since `V1.0.0`) +* [x] 完善测试用例 (`Doing`) +* [x] 修bugs（目前代码还比较凌乱。。） (`Doing`) +* [x] 支持`空格`识别（since `V1.1.0`） +* [x] 尝试新模型，如 DenseNet，进一步提升识别准确率（since `V1.1.0`） +* [x] 优化训练集，去掉不合理的样本；在此基础上，重新训练各个模型 +* [x] 由 MXNet 改为 PyTorch 架构（since `V2.0.0`） +* [x] 基于 PyTorch 训练更高效的模型 +* [x] 支持列格式的文字识别 +* [x] 打通与 [CnSTD](https://github.com/breezedeus/cnstd) 的无缝衔接（since `V2.2`） +* [ ] 支持更多的应用场景，如公式识别、表格识别、版面分析等 +## 给作者来杯咖啡 + +%prep +%autosetup -n cnocr-2.2.2.3 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-cnocr -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 17 2023 Python_Bot <Python_Bot@openeuler.org> - 2.2.2.3-1 +- Package Spec generated @@ -0,0 +1 @@ +f7bf137a9c6320925b436400de3e5f5d cnocr-2.2.2.3.tar.gz |