Korean PP OCRv3 Mobile Rec

🚀 korean_PP-OCRv3_mobile_rec

korean_PP-OCRv3_mobile_rec is a text line recognition model developed by the PaddleOCR team, specifically designed for Korean recognition.

🚀 Quick Start

📦 Installation

1. PaddlePaddle

Please refer to the following commands to install PaddlePaddle using pip:

# for CUDA11.8
python -m pip install paddlepaddle-gpu==3.0.0 -i https://www.paddlepaddle.org.cn/packages/stable/cu118/

# for CUDA12.6
python -m pip install paddlepaddle-gpu==3.0.0 -i https://www.paddlepaddle.org.cn/packages/stable/cu126/

# for CPU
python -m pip install paddlepaddle==3.0.0 -i https://www.paddlepaddle.org.cn/packages/stable/cpu/

For details about PaddlePaddle installation, please refer to the PaddlePaddle official website.

2. PaddleOCR

Install the latest version of the PaddleOCR inference package from PyPI:

python -m pip install paddleocr

💻 Usage Examples

🔍 Basic Usage

You can quickly experience the functionality with a single command:

paddleocr text_recognition \
    --model_name korean_PP-OCRv3_mobile_rec \
    -i https://cdn-uploads.huggingface.co/production/uploads/681c1ecd9539bdde5ae1733c/ZTHbb6G5z-OyxRMRquT0f.png

You can also integrate the model inference of the text recognition module into your project. Before running the following code, please download the sample image to your local machine.

from paddleocr import TextRecognition
model = TextRecognition(model_name="korean_PP-OCRv3_mobile_rec")
output = model.predict(input="ZTHbb6G5z-OyxRMRquT0f.png", batch_size=1)
for res in output:
    res.print()
    res.save_to_img(save_path="./output/")
    res.save_to_json(save_path="./output/res.json")

After running, the obtained result is as follows:

{'res': {'input_path': '/root/.paddlex/predict_input/ZTHbb6G5z-OyxRMRquT0f.png', 'page_index': None, 'rec_text': '한국어테스트케이스', 'rec_score': 0.9998695850372314}}

For details about usage command and descriptions of parameters, please refer to the Document.

🔝 Advanced Usage

The ability of a single model is limited. But the pipeline consists of several models can provide more capacity to resolve difficult problems in real-world scenarios.

PP-OCRv3

The general OCR pipeline is used to solve text recognition tasks by extracting text information from images and outputting it in string format. And there are 5 modules in the pipeline:

• Document Image Orientation Classification Module (Optional)
• Text Image Unwarping Module (Optional)
• Text Line Orientation Classification Module (Optional)
• Text Detection Module
• Text Recognition Module

Run a single command to quickly experience the OCR pipeline:

paddleocr ocr -i https://cdn-uploads.huggingface.co/production/uploads/681c1ecd9539bdde5ae1733c/MCFByPiFcNs118O8mOiis.png \
    --text_recognition_model_name korean_PP-OCRv3_mobile_rec \
    --use_doc_orientation_classify False \
    --use_doc_unwarping False \
    --use_textline_orientation True \
    --save_path ./output \
    --device gpu:0 

Results are printed to the terminal:

{'res': {'input_path': '/root/.paddlex/predict_input/MCFByPiFcNs118O8mOiis.png', 'page_index': None, 'model_settings': {'use_doc_preprocessor': True, 'use_textline_orientation': True}, 'doc_preprocessor_res': {'input_path': None, 'page_index': None, 'model_settings': {'use_doc_orientation_classify': False, 'use_doc_unwarping': False}, 'angle': -1}, 'dt_polys': array([[[11,  3],
        ...,
        [11, 32]],

       [[10, 33],
        ...,
        [10, 60]]], dtype=int16), 'text_det_params': {'limit_side_len': 64, 'limit_type': 'min', 'thresh': 0.3, 'max_side_limit': 4000, 'box_thresh': 0.6, 'unclip_ratio': 1.5}, 'text_type': 'general', 'textline_orientation_angles': array([0, 0]), 'text_rec_score_thresh': 0.0, 'rec_texts': ['한국어다중줄텍스트테', '스트케이스'], 'rec_scores': array([0.99944037, 0.9882015 ]), 'rec_polys': array([[[11,  3],
        ...,
        [11, 32]],

       [[10, 33],
        ...,
        [10, 60]]], dtype=int16), 'rec_boxes': array([[11, ..., 32],
       [10, ..., 62]], dtype=int16)}}

The command-line method is for quick experience. For project integration, also only a few codes are needed as well:

from paddleocr import PaddleOCR  

ocr = PaddleOCR(
    text_recognition_model_name="korean_PP-OCRv3_mobile_rec",
    use_doc_orientation_classify=False, # Use use_doc_orientation_classify to enable/disable document orientation classification model
    use_doc_unwarping=False, # Use use_doc_unwarping to enable/disable document unwarping module
    use_textline_orientation=True, # Use use_textline_orientation to enable/disable textline orientation classification model
    device="gpu:0", # Use device to specify GPU for model inference
)
result = ocr.predict("https://cdn-uploads.huggingface.co/production/uploads/681c1ecd9539bdde5ae1733c/MCFByPiFcNs118O8mOiis.png")  
for res in result:  
    res.print()  
    res.save_to_img("output")  
    res.save_to_json("output")

The default model used in pipeline is PP-OCRv5_server_rec, so it is needed that specifing to korean_PP-OCRv3_mobile_rec by argument text_recognition_model_name. And you can also use the local model file by argument text_recognition_model_dir. For details about usage command and descriptions of parameters, please refer to the Document.

📚 Documentation

korean_PP-OCRv3_mobile_rec is a text line recognition model within the PP-OCRv3_rec series, developed by the PaddleOCR team. The korean_PP-OCRv3_mobile_rec model is an Korean-specific model trained based on PP-OCRv3_mobile_rec, and it supports Korean recognition. The key accuracy metrics are as follow:

Note: If any character (including punctuation) in a line was incorrect, the entire line was marked as wrong. This ensures higher accuracy in practical applications.

📄 License

This project is licensed under the Apache-2.0 license.

🔗 Links

• PaddleOCR Repo
• PaddleOCR Documentation