README_CN.md

PaddleOCRFastAPI

一个可 Docker (Compose) 部署的, 基于 FastAPI 的简易版 Paddle OCR Web API.

版本选择

PaddleOCR	Branch
v2.5	paddleocr-v2.5
v2.7	paddleocr-v2.7

接口功能

• 局域网范围内路径图片 OCR 识别
• Base64 数据识别
• 上传文件识别

部署方式

直接部署

1. 复制项目至部署路径

   git clone https://github.com/cgcel/PaddleOCRFastAPI.git

   master 分支为项目中支持的 PaddleOCR 的最新版本, 如需安装特定版本, 请克隆对应版本号的分支.

2. (可选) 新建虚拟环境, 避免依赖冲突

3. 安装所需依赖

   pip3 install -r requirements.txt

4. 运行 FastAPI

   uvicorn main:app --host 0.0.0.0

Docker 部署

在 Centos 7, Ubuntu 20.04, Ubuntu 22.04, Windows 10, Windows 11 中测试成功, 需要先安装好 Docker.

1. 复制项目至部署路径

   git clone https://github.com/cgcel/PaddleOCRFastAPI.git

   master 分支为项目中支持的 PaddleOCR 的最新版本, 如需安装特定版本, 请克隆对应版本号的分支.

2. 制作 Docker 镜像

   docker build -t paddleocrfastapi:latest .

3. 编辑 docker-compose.yml

   version: "3"
   
   services:
   
     paddleocrfastapi:
       container_name: paddleocrfastapi # 自定义容器名
       image: paddleocrfastapi:latest # 第2步自定义的镜像名与标签
       environment:
         - TZ=Asia/Hong_Kong
       ports:
        - 8000:8000 # 自定义服务暴露端口, 8000 为 FastAPI 默认端口, 不做修改
       restart: unless-stopped

4. 生成 Docker 容器并运行

   docker-compose up -d

5. Swagger 页面请访问 localhost:<port>/docs

Change language

1. 将此仓库克隆至本地.

2. 编辑 routers/ocr.py, 修改参数 "lang":

   ocr = PaddleOCR(use_angle_cls=True, lang="ch")

   编辑前, 先阅读 supported language list.

3. 重新创建 docker 镜像, 或直接运行 main.py.

运行截图

API 文档：/docs

Todo

• support ppocr v4
• GPU mode
• Image url recognition

License

PaddleOCRFastAPI is licensed under the MIT license. Refer to LICENSE for more information.