README_en.md

English | 简体中文 | हिन्दी | 日本語 | 한국인 | Pу́сский язы́к

Introduction

PaddleOCR aims to create multilingual, awesome, leading, and practical OCR tools that help users train better models and apply them into practice.

🚀 Community

PaddleOCR is being oversight by a PMC. Issues and PRs will be reviewed on a best-effort basis. For a complete overview of PaddlePaddle community, please visit community.

⚠️ Note: The Issues module is only for reporting program 🐞 bugs, for the rest of the questions, please move to the Discussions. Please note that if the Issue mentioned is not a bug, it will be moved to the Discussions module.

📣 Recent updates

• 🔥2023.8.7 Release PaddleOCRrelease/2.7

  • Release PP-OCRv4, support mobile version and server version
    • PP-OCRv4-mobile：When the speed is comparable, the effect of the Chinese scene is improved by 4.5% compared with PP-OCRv3, the English scene is improved by 10%, and the average recognition accuracy of the 80-language multilingual model is increased by more than 8%.
    • PP-OCRv4-server：Release the OCR model with the highest accuracy at present, the detection model accuracy increased by 4.9% in the Chinese and English scenes, and the recognition model accuracy increased by 2% refer quickstart quick use by one line command, At the same time, the whole process of model training, reasoning, and high-performance deployment can also be completed with few code in the General OCR Industry Solution in PaddleX.
  • ReleasePP-ChatOCR, a new scheme for extracting key information of general scenes using PP-OCR model and ERNIE LLM.

• 🔨2022.11 Add implementation of 4 cutting-edge algorithms：Text Detection DRRG, Text Recognition RFL, Image Super-Resolution Text Telescope，Handwritten Mathematical Expression Recognition CAN

• 2022.10 release optimized JS version PP-OCRv3 model with 4.3M model size, 8x faster inference time, and a ready-to-use web demo

• 💥 Live Playback: Introduction to PP-StructureV2 optimization strategy. Scan the QR code below using WeChat, follow the PaddlePaddle official account and fill out the questionnaire to join the WeChat group, get the live link and 20G OCR learning materials (including PDF2Word application, 10 models in vertical scenarios, etc.)

• 🔥2022.8.24 Release PaddleOCR release/2.6

  • Release PP-StructureV2，with functions and performance fully upgraded, adapted to Chinese scenes, and new support for Layout Recovery and one line command to convert PDF to Word;
  • Layout Analysis optimization: model storage reduced by 95%, while speed increased by 11 times, and the average CPU time-cost is only 41ms;
  • Table Recognition optimization: 3 optimization strategies are designed, and the model accuracy is improved by 6% under comparable time consumption;
  • Key Information Extraction optimization：a visual-independent model structure is designed, the accuracy of semantic entity recognition is increased by 2.8%, and the accuracy of relation extraction is increased by 9.1%.

• 🔥2022.8 Release OCR scene application collection

  • Release 9 vertical models such as digital tube, LCD screen, license plate, handwriting recognition model, high-precision SVTR model, etc, covering the main OCR vertical applications in general, manufacturing, finance, and transportation industries.

• 2022.8 Add implementation of 8 cutting-edge algorithms

  • Text Detection: FCENet, DB++
  • Text Recognition: ViTSTR, ABINet, VisionLAN, SPIN, RobustScanner
  • Table Recognition: TableMaster

• 2022.5.9 Release PaddleOCR release/2.5

  • Release PP-OCRv3: With comparable speed, the effect of Chinese scene is further improved by 5% compared with PP-OCRv2, the effect of English scene is improved by 11%, and the average recognition accuracy of 80 language multilingual models is improved by more than 5%.
  • Release PPOCRLabelv2: Add the annotation function for table recognition task, key information extraction task and irregular text image.
  • Release interactive e-book "Dive into OCR", covers the cutting-edge theory and code practice of OCR full stack technology.

• more

🌟 Features

PaddleOCR support a variety of cutting-edge algorithms related to OCR, and developed industrial featured models/solution PP-OCR、 PP-Structure and PP-ChatOCR on this basis, and get through the whole process of data production, model training, compression, inference and deployment.

It is recommended to start with the “quick experience” in the document tutorial

⚡ Quick Experience

• Web online experience
  • PP-OCRv4 online experience：https://aistudio.baidu.com/aistudio/projectdetail/6611435
  • PP-ChatOCR online experience：https://aistudio.baidu.com/aistudio/projectdetail/6488689
• One line of code quick use: Quick Start（Chinese/English/Multilingual/Document Analysis
• Full-process experience of training, inference, and high-performance deployment in the Paddle AI suite (PaddleX)：
  • PP-OCRv4：https://aistudio.baidu.com/aistudio/modelsdetail?modelId=286
  • PP-ChatOCR：https://aistudio.baidu.com/aistudio/modelsdetail?modelId=332
• Mobile demo experience：Installation DEMO(Based on EasyEdge and Paddle-Lite, support iOS and Android systems)

📖 Technical exchange and cooperation

• PaddleX provides a one-stop full-process high-efficiency development platform for flying paddle ecological model training, pressure, and push. Its mission is to help AI technology quickly land, and its vision is to make everyone an AI Developer!
  • PaddleX currently covers areas such as image classification, object detection, image segmentation, 3D, OCR, and time series prediction, and has built-in 36 basic single models, such as RP-DETR, PP-YOLOE, PP-HGNet, PP-LCNet, PP- LiteSeg, etc.; integrated 12 practical industrial solutions, such as PP-OCRv4, PP-ChatOCR, PP-ShiTu, PP-TS, vehicle-mounted road waste detection, identification of prohibited wildlife products, etc.
  • PaddleX provides two AI development modes: "Toolbox" and "Developer". The toolbox mode can tune key hyperparameters without code, and the developer mode can perform single-model training, push and multi-model serial inference with low code, and supports both cloud and local terminals.
  • PaddleX also supports joint innovation and development, profit sharing! At present, PaddleX is rapidly iterating, and welcomes the participation of individual developers and enterprise developers to create a prosperous AI technology ecosystem!

📚 E-book: Dive Into OCR

• Dive Into OCR

🛠️ PP-OCR Series Model List（Update on September 8th）

Model introduction	Model name	Recommended scene	Detection model	Direction classifier	Recognition model
Chinese and English ultra-lightweight PP-OCRv4 model（16.2M）	ch_PP-OCRv4_xx	Mobile & Server	inference model / trained model	inference model / trained model	inference model / trained model
Chinese and English ultra-lightweight PP-OCRv3 model（16.2M）	ch_PP-OCRv3_xx	Mobile & Server	inference model / trained model	inference model / trained model	inference model / trained model
English ultra-lightweight PP-OCRv3 model（13.4M）	en_PP-OCRv3_xx	Mobile & Server	inference model / trained model	inference model / trained model	inference model / trained model

• For more model downloads (including multiple languages), please refer to PP-OCR series model downloads.
• For a new language request, please refer to Guideline for new language_requests.
• For structural document analysis models, please refer to PP-Structure models.

📖 Tutorials

• Environment Preparation
• PP-OCR 🔥
  • Quick Start
  • Model Zoo
  • Model training
    • Text Detection
    • Text Recognition
    • Text Direction Classification
  • Model Compression
    • Model Quantization
    • Model Pruning
    • Knowledge Distillation
  • Inference and Deployment
    • Python Inference
    • C++ Inference
    • Serving
    • Mobile
    • Paddle2ONNX
    • PaddleCloud
    • Benchmark
• PP-Structure 🔥
  • Quick Start
  • Model Zoo
  • Model training
    • Layout Analysis
    • Table Recognition
    • Key Information Extraction
  • Inference and Deployment
    • Python Inference
    • C++ Inference
    • Serving
• Academic Algorithms
  • Text detection
  • Text recognition
  • End-to-end OCR
  • Table Recognition
  • Key Information Extraction
  • Add New Algorithms to PaddleOCR
• Data Annotation and Synthesis
  • Semi-automatic Annotation Tool: PPOCRLabel
  • Data Synthesis Tool: Style-Text
  • Other Data Annotation Tools
  • Other Data Synthesis Tools
• Datasets
  • General OCR Datasets(Chinese/English)
  • HandWritten_OCR_Datasets(Chinese)
  • Various OCR Datasets(multilingual)
  • Layout Analysis
  • Table Recognition
  • Key Information Extraction
• Code Structure
• Visualization
• Community
• New language requests
• FAQ
• References
• License

👀 Visualization more

PP-OCRv3 Chinese model

PP-OCRv3 English model

PP-OCRv3 Multilingual model

PP-StructureV2

• layout analysis + table recognition

• SER (Semantic entity recognition)

• RE (Relation Extraction)

## 🇺🇳 Guideline for New Language Requests

If you want to request a new language support, a PR with 1 following files are needed：

1. In folder ppocr/utils/dict, it is necessary to submit the dict text to this path and name it with {language}_dict.txt that contains a list of all characters. Please see the format example from other files in that folder.

If your language has unique elements, please tell me in advance within any way, such as useful links, wikipedia and so on.

More details, please refer to Multilingual OCR Development Plan.

📄 License

This project is released under Apache 2.0 license