tr - 文本识别

一款针对扫描文档的离线文本识别SDK，核心代码全部采用C++开发，并提供Python接口

编译环境: Ubuntu 16.04

为什么开发tr？

我刚开发tr时，网上只有chineseocr、 tesseract等少数开源OCR。tr发布后，又诞生了几款优秀的开源OCR。tr也基本上完成了自己的使命，会转为一个研究型项目，追求技术的先进性而不是实用性。

暂停维护说明

在研究OCR的过程中，我发现了更有趣的Transformer技术，这是一种有希望单个算法解决绝大部分深度学习任务（包括OCR）的技术。未来的算法工程师可能不再需要学习各种各样的算法，只需要学习一款算法即可。后续我们将暂停维护本项目，重点研究Transformer技术

免责声明

最近看到一些半开源/闭源免费软件被用户投诉举报，甚至追究法律责任的案例，感觉有必要加入免责声明：

• 本软件存在风险，包括但不限于闪退、内存泄漏，所有风险由用户承担
• 若在软件使用过程中出现异常导致损失，用户承担全部责任

更新说明

• c++接口支持
• 添加python2支持
• 去除opencv-python、Pillow依赖，降低部署难度
• 支持多线程

Requirements

• python2/python3，需要安装numpy
• 不支持Windows、CentOS 6、ARM

GPU版本安装说明

由于新型号的显卡需要更高版本的CUDA，GPU版本暂时只支持旧型号的显卡。
如果对速度有要求，推荐安装GPU版本
要使用GPU版本，复制tr_gpu文件夹里面的文件到tr文件夹
注意: 需要先安装CUDA 10.1以及cuDNN 7.6.5。

若不想安装CUDA/cuDNN，可以使用docker部署

docker pull mcr.microsoft.com/azureml/onnxruntime:v1.3.0-cuda10.1-cudnn7
sudo nvidia-docker run -v /path/to/tr:/path/to/tr --rm -it mcr.microsoft.com/azureml/onnxruntime:v1.3.0-cuda10.1-cudnn7

Install

• 安装方法一

git clone https://github.com/myhub/tr.git
cd ./tr
sudo python setup.py install

• 安装方法二

sudo pip install git+https://github.com/myhub/tr.git@master

Test

python2 demo.py               # python2兼容测试
python3 test.py               # 可视化测试
python3 test-multi-thread.py  # 多线程测试
python3 test_crnn_pyqt5.py    # 截图识别

关联项目

• 若需要Web端调用，推荐参考TrWebOCR

Python Example

import tr

# detect text lines, return list of (cx, cy, width, height, angle)
print(tr.detect("imgs/web.png", tr.FLAG_RECT))

# detect text lines with angle, return list of (cx, cy, width, height, angle)
print(tr.detect("imgs/id_card.jpeg", tr.FLAG_ROTATED_RECT))

# recognize text line, return (text, confidence)
print(tr.recognize("imgs/line.png"))

# detect and recognize text lines with angle, return list of ((cx, cy, width, height, angle), text, confidence)
print(tr.run("imgs/id_card.jpeg"))

C++ Example

tr_init(0, 0, "crnn.bin", NULL);

#define MAX_WIDTH		512
int unicode[MAX_WIDTH];
float prob[MAX_WIDTH]; 

auto ws = tr_recognize(0, (void *)"line.png", 0, 0, 0, unicode, prob, MAX_WIDTH);

tr_release(0);

效果展示

---

tr 文本识别快速上手指南

tr 是一款针对扫描文档的离线文本识别 SDK，核心代码采用 C++ 开发并提供 Python 接口。本项目目前主要作为研究型项目，适用于 Ubuntu 环境下的文本行检测与识别任务。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：推荐 Ubuntu 16.04 或更高版本。
  • 注意：不支持 Windows、CentOS 6 及 ARM 架构。
• Python 版本：支持 Python 2 或 Python 3。
• 前置依赖：
  • 必须安装 numpy。
  • 已移除对 opencv-python 和 Pillow 的强制依赖，降低部署难度。
• GPU 支持（可选）：
  • 仅支持旧型号显卡。
  • 需预先安装 CUDA 10.1 和 cuDNN 7.6.5。
  • 若不想配置本地 CUDA 环境，推荐使用 Docker 部署。

安装步骤

您可以选择以下任意一种方式进行安装。推荐使用方法一以获取完整源码，或使用清华镜像源加速安装。

方法一：源码安装（推荐）

git clone https://github.com/myhub/tr.git
cd ./tr
sudo python setup.py install

方法二：pip 直接安装

# 使用默认源
sudo pip install git+https://github.com/myhub/tr.git@master

# 或者使用清华镜像源加速
sudo pip install git+https://github.com/myhub/tr.git@master -i https://pypi.tuna.tsinghua.edu.cn/simple

GPU 版本特别说明

如果需要启用 GPU 加速且已安装 CUDA 10.1/cuDNN 7.6.5：

1. 将源码中 tr_gpu 文件夹内的文件复制到 tr 文件夹覆盖。
2. 或者使用官方提供的 Docker 镜像：

docker pull mcr.microsoft.com/azureml/onnxruntime:v1.3.0-cuda10.1-cudnn7
sudo nvidia-docker run -v /path/to/tr:/path/to/tr --rm -it mcr.microsoft.com/azureml/onnxruntime:v1.3.0-cuda10.1-cudnn7

基本使用

安装完成后，即可通过 Python 调用 tr 库进行文本检测与识别。

1. 初始化与简单识别

最基础的用法是初始化 CRNN 网络并识别单张文本行图片：

import tr

# 初始化文本行识别网络
crnn = tr.CRNN()

# 识别文本行 (输入图片路径)
chars, scores = crnn.run("imgs/line.png")

# 打印识别结果
print("".join(chars))

2. 高级功能：检测与识别

tr 提供了更丰富的 API，支持文本行检测（含角度）、单独识别以及端到端的检测 + 识别流程：

import tr

# 1. 检测文本行 (返回矩形框坐标: cx, cy, width, height, angle)
# tr.FLAG_RECT 表示水平矩形框
print(tr.detect("imgs/web.png", tr.FLAG_RECT))

# 2. 检测带角度的文本行 (返回旋转矩形框坐标)
# tr.FLAG_ROTATED_RECT 适用于倾斜文本
print(tr.detect("imgs/id_card.jpeg", tr.FLAG_ROTATED_RECT))

# 3. 单独识别文本行 (返回文本内容和置信度)
print(tr.recognize("imgs/line.png"))

# 4. 一站式流程：检测并识别带角度的文本行
# 返回格式：((cx, cy, width, height, angle), text, confidence)
print(tr.run("imgs/id_card.jpeg"))

3. C++ 接口示例

如果您需要在 C++ 项目中集成，可使用以下接口：

tr_init(0, 0, "crnn.bin", NULL);

#define MAX_WIDTH		512
int unicode[MAX_WIDTH];
float prob[MAX_WIDTH]; 

auto ws = tr_recognize(0, (void *)"line.png", 0, 0, 0, unicode, prob, MAX_WIDTH);

tr_release(0);

提示：如需图形化界面体验截图识别功能，请安装 PyQt5 后运行 python -m tr.gui。