Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,3 +1,171 @@
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: apache-2.0
|
| 3 |
+
library_name: PaddleOCR
|
| 4 |
+
language:
|
| 5 |
+
- en
|
| 6 |
+
- zh
|
| 7 |
+
pipeline_tag: image-to-text
|
| 8 |
+
tags:
|
| 9 |
+
- OCR
|
| 10 |
+
- PaddlePaddle
|
| 11 |
+
- PaddleOCR
|
| 12 |
+
- textline_detection
|
| 13 |
---
|
| 14 |
+
|
| 15 |
+
<div align="center">
|
| 16 |
+
|
| 17 |
+
|
| 18 |
+
<h1 align="center">
|
| 19 |
+
|
| 20 |
+
PP-OCRv6: From 1.5M to 34.5M Parameters, Surpassing Billion-Scale VLMs on OCR Tasks
|
| 21 |
+
|
| 22 |
+
</h1>
|
| 23 |
+
|
| 24 |
+
[](https://github.com/PaddlePaddle/PaddleOCR)
|
| 25 |
+
[](https://huggingface.co/PaddlePaddle/PP-OCRv6_tiny_det)
|
| 26 |
+
[](https://x.com/PaddlePaddle)
|
| 27 |
+
[](./LICENSE)
|
| 28 |
+
[](https://huggingface.co/PaddlePaddle/PP-OCRv6_tiny_det_safetensors)
|
| 29 |
+
[](https://huggingface.co/PaddlePaddle/PP-OCRv6_tiny_det_onnx)
|
| 30 |
+
|
| 31 |
+
|
| 32 |
+
**🔥 [Official Website](https://www.paddleocr.com)**
|
| 33 |
+
**📝 [Technical Report (Coming soon)](https://arxiv.org/abs/xxxx.xxxxx)**
|
| 34 |
+
|
| 35 |
+
</div>
|
| 36 |
+
|
| 37 |
+
<div align="center">
|
| 38 |
+
<img src="https://cdn-uploads.huggingface.co/production/uploads/684ba591e717a30275a1b76a/0XIrg0UmmOvplnPjmsmK3.png" width="800"/>
|
| 39 |
+
</div>
|
| 40 |
+
|
| 41 |
+
## PP-OCRv6 Overview
|
| 42 |
+
|
| 43 |
+
PP-OCRv6 is a lightweight OCR system that combines architectural innovation with data-centric optimization. It redesigns the backbone, detection neck, and recognition neck around a unified MetaFormer-style building block with structural reparameterization. Three model tiers (medium, small, tiny) share the same block primitives, covering deployment scenarios from server to edge.
|
| 44 |
+
|
| 45 |
+
### Key Features
|
| 46 |
+
|
| 47 |
+
1. **Unified and Scalable Model Family:** A three-tier OCR model family spanning 1.5M to 34.5M parameters. PP-OCRv6_medium achieves 86.2% detection Hmean and 83.2% recognition accuracy, outperforming PP-OCRv5_server by +4.6% and +5.1% respectively.
|
| 48 |
+
|
| 49 |
+
2. **Lightweight Architectural Innovations:** (i) LCNetV4, a MetaFormer-style lightweight backbone with structural reparameterization; (ii) RepLKFPN, a detection neck with dilated reparameterizable depthwise convolutions; (iii) EncoderWithLightSVTR, a recognition neck with local-global attention and additive skip connections.
|
| 50 |
+
|
| 51 |
+
3. **Multi-Language and Scenario Support:** Supports 48 languages and diverse industrial scenes (digital displays, dot-matrix characters, tire prints, etc.), surpassing Qwen3-VL-235B, GPT-5.5, and Gemini-3.1-Pro with orders of magnitude fewer parameters.
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
# PP-OCRv6_tiny_det
|
| 55 |
+
|
| 56 |
+
## Introduction
|
| 57 |
+
|
| 58 |
+
<div align="center">
|
| 59 |
+
<img src="https://cdn-uploads.huggingface.co/production/uploads/684ba591e717a30275a1b76a/ofnSGExgJL6K6d8ghh0vl.png" width="600"/>
|
| 60 |
+
|
| 61 |
+
PP-OCRv6 text detection architecture overview
|
| 62 |
+
</div>
|
| 63 |
+
|
| 64 |
+
PP-OCRv6_tiny_det is the tiny model in the PP-OCRv6 detection series developed by the PaddleOCR team. It uses LCNetV4 as the backbone and RepLKFPN as the feature pyramid neck, providing accurate text localization across diverse scenarios including handwritten, printed, rotated, curved, and artistic text in multiple languages. The model contains 0.43M parameters. The key accuracy metrics are as follows:
|
| 65 |
+
|
| 66 |
+
| Model | Average | Handwritten CN | Handwritten EN | Printed CN | Printed EN | Traditional Chinese | Ancient Text | Japanese | Blur | Emoji | Warp | Pinyin | Artistic | Table | Rotation | Industrial | General |
|
| 67 |
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
| 68 |
+
| Gemini-3.1-Pro | 46.8 | 53.4 | 56.5 | 47.3 | 47.6 | 39.0 | 45.8 | 38.2 | 50.0 | 68.1 | 44.6 | 40.6 | 65.2 | 26.9 | 22.1 | 52.5 | 50.2 |
|
| 69 |
+
| GPT-5.5 | 45.6 | 42.4 | 58.5 | 50.2 | 51.9 | 35.0 | 26.7 | 42.0 | 49.1 | 97.5 | 37.7 | 36.3 | 52.0 | 71.0 | 10.0 | 36.2 | 32.6 |
|
| 70 |
+
| Qwen3-VL-235B | 38.3 | 56.5 | 66.0 | 41.7 | 37.0 | 19.3 | 13.1 | 27.0 | 38.5 | 81.2 | 28.5 | 33.0 | 68.3 | 19.6 | 2.1 | 48.4 | 32.3 |
|
| 71 |
+
| Kimi-K2.6 | 12.8 | 12.5 | 25.5 | 10.1 | 18.5 | 8.2 | 7.5 | 11.2 | 16.9 | 28.9 | 13.9 | 6.8 | 16.1 | 10.9 | 0.8 | 6.3 | 10.9 |
|
| 72 |
+
| MiniMax-M3 | 12.0 | 13.7 | 19.3 | 9.8 | 14.1 | 7.7 | 11.1 | 10.6 | 16.1 | 32.8 | 12.8 | 8.5 | 16.6 | 5.5 | 0.1 | 6.4 | 6.4 |
|
| 73 |
+
| PP-OCRv5_server | 81.6 | 80.3 | 84.1 | 94.5 | 91.7 | 81.5 | 67.6 | 77.2 | 90.1 | 96.2 | 87.6 | 67.1 | 67.3 | 97.1 | 80.0 | 64.3 | 79.7 |
|
| 74 |
+
| PP-OCRv5_mobile | 75.2 | 74.4 | 77.7 | 90.5 | 91.0 | 82.3 | 58.1 | 72.7 | 87.4 | 93.6 | 82.7 | 57.5 | 52.5 | 92.8 | 64.7 | 52.8 | 72.1 |
|
| 75 |
+
| PP-OCRv6_medium | 86.2 | 83.7 | 84.0 | 95.1 | 93.7 | 86.3 | 80.2 | 84.3 | 94.1 | 99.6 | 88.6 | 74.0 | 69.0 | 96.8 | 93.8 | 73.3 | 82.8 |
|
| 76 |
+
| PP-OCRv6_small | 84.1 | 80.5 | 87.1 | 94.2 | 93.6 | 85.7 | 72.6 | 82.3 | 92.6 | 99.7 | 87.6 | 69.6 | 65.3 | 95.6 | 93.7 | 67.6 | 78.2 |
|
| 77 |
+
| **PP-OCRv6_tiny** | **80.6** | **79.4** | **85.9** | **93.1** | **92.3** | **83.7** | **63.0** | **76.6** | **89.3** | **99.8** | **86.1** | **59.0** | **60.1** | **94.7** | **91.0** | **62.0** | **73.8** |
|
| 78 |
+
|
| 79 |
+
## Quick Start
|
| 80 |
+
|
| 81 |
+
### Installation
|
| 82 |
+
|
| 83 |
+
```bash
|
| 84 |
+
# Install the basic version
|
| 85 |
+
pip install paddleocr
|
| 86 |
+
|
| 87 |
+
# Install the full version (includes all features)
|
| 88 |
+
pip install "paddleocr[all]"
|
| 89 |
+
```
|
| 90 |
+
|
| 91 |
+
> This model uses the `paddle_static` inference engine by default. Please complete [PaddlePaddle installation](https://www.paddlepaddle.org.cn/en/install/quick) before use.
|
| 92 |
+
|
| 93 |
+
### Model Usage
|
| 94 |
+
|
| 95 |
+
You can quickly experience the functionality with a single command:
|
| 96 |
+
|
| 97 |
+
```bash
|
| 98 |
+
paddleocr text_detection \
|
| 99 |
+
--model_name PP-OCRv6_tiny_det \
|
| 100 |
+
-i https://cdn-uploads.huggingface.co/production/uploads/681c1ecd9539bdde5ae1733c/3ul2Rq4Sk5Cn-l69D695U.png
|
| 101 |
+
```
|
| 102 |
+
|
| 103 |
+
You can also integrate the model inference of the text detection module into your project. Before running the following code, please download the sample image to your local machine.
|
| 104 |
+
|
| 105 |
+
```python
|
| 106 |
+
from paddleocr import TextDetection
|
| 107 |
+
model = TextDetection(model_name="PP-OCRv6_tiny_det")
|
| 108 |
+
output = model.predict(input="3ul2Rq4Sk5Cn-l69D695U.png", batch_size=1)
|
| 109 |
+
for res in output:
|
| 110 |
+
res.print()
|
| 111 |
+
res.save_to_img(save_path="./output/")
|
| 112 |
+
res.save_to_json(save_path="./output/res.json")
|
| 113 |
+
```
|
| 114 |
+
|
| 115 |
+
<!-- TODO: Update document links to PP-OCRv6 official documentation when available -->
|
| 116 |
+
For details about usage command and descriptions of parameters, please refer to the [Document](https://paddlepaddle.github.io/PaddleOCR/latest/en/version3.x/module_usage/text_detection.html#iii-quick-start).
|
| 117 |
+
|
| 118 |
+
### Pipeline Usage
|
| 119 |
+
|
| 120 |
+
The general OCR pipeline extracts text information from images. The pipeline consists of several modules:
|
| 121 |
+
* Document Image Orientation Classification Module (Optional)
|
| 122 |
+
* Text Image Unwarping Module (Optional)
|
| 123 |
+
* Text Line Orientation Classification Module (Optional)
|
| 124 |
+
* Text Detection Module
|
| 125 |
+
* Text Recognition Module
|
| 126 |
+
|
| 127 |
+
Run a single command to quickly experience the OCR pipeline:
|
| 128 |
+
|
| 129 |
+
```bash
|
| 130 |
+
paddleocr ocr -i https://cdn-uploads.huggingface.co/production/uploads/681c1ecd9539bdde5ae1733c/3ul2Rq4Sk5Cn-l69D695U.png \
|
| 131 |
+
--text_detection_model_name PP-OCRv6_tiny_det \
|
| 132 |
+
--text_recognition_model_name PP-OCRv6_tiny_rec \
|
| 133 |
+
--use_doc_orientation_classify False \
|
| 134 |
+
--use_doc_unwarping False \
|
| 135 |
+
--use_textline_orientation True \
|
| 136 |
+
--save_path ./output \
|
| 137 |
+
--device gpu:0
|
| 138 |
+
```
|
| 139 |
+
|
| 140 |
+
For project integration:
|
| 141 |
+
|
| 142 |
+
```python
|
| 143 |
+
from paddleocr import PaddleOCR
|
| 144 |
+
|
| 145 |
+
ocr = PaddleOCR(
|
| 146 |
+
text_detection_model_name="PP-OCRv6_tiny_det",
|
| 147 |
+
text_recognition_model_name="PP-OCRv6_tiny_rec",
|
| 148 |
+
use_doc_orientation_classify=False,
|
| 149 |
+
use_doc_unwarping=False,
|
| 150 |
+
use_textline_orientation=False,
|
| 151 |
+
)
|
| 152 |
+
result = ocr.predict("./3ul2Rq4Sk5Cn-l69D695U.png")
|
| 153 |
+
for res in result:
|
| 154 |
+
res.print()
|
| 155 |
+
res.save_to_img("output")
|
| 156 |
+
res.save_to_json("output")
|
| 157 |
+
```
|
| 158 |
+
|
| 159 |
+
<!-- TODO: Update document links to PP-OCRv6 official documentation when available -->
|
| 160 |
+
For details about usage command and descriptions of parameters, please refer to the [Document](https://paddlepaddle.github.io/PaddleOCR/latest/en/version3.x/pipeline_usage/OCR.html#2-quick-start).
|
| 161 |
+
|
| 162 |
+
## Links
|
| 163 |
+
|
| 164 |
+
[PaddleOCR Repo](https://github.com/paddlepaddle/paddleocr)
|
| 165 |
+
|
| 166 |
+
[PaddleOCR Documentation](https://paddlepaddle.github.io/PaddleOCR/latest/en/index.html)
|
| 167 |
+
|
| 168 |
+
<!-- TODO: Update arxiv link when PP-OCRv6 paper is published -->
|
| 169 |
+
## Citation
|
| 170 |
+
|
| 171 |
+
Coming soon.
|