Skip to main content

Lightweight PP-OCR runtime – ONNX only, no OpenCV, no heavy frameworks

Project description

ppocr-lite

A lightweight PaddlePaddle-OCR runtime for images like screenshots.

Dependency Role
numpy All numerical computation
Pillow Image I/O and resize
onnxruntime Model inference
scipy (optional) Faster connected-component labelling

No OpenCV, deep-learning framework or utility libraries.


Install

pip install ppocr-lite        # CPU
pip install ppocr-lite[gpu]   # GPU (uses onnxruntime-gpu)
pip install ppocr-lite[fast]  # + scipy for faster CC labelling

Models (PP-OCRv5 mobile det/rec + v2 direction cls) can be auto-downloaded to ~/.cache/ppocr_lite/ on first use, or manually downloaded and configured.

Automatically downloaded models come from RapidOCR and are downloaded from huggingface (see here for details).

To manually download models see their huggingface - you'll need one det.onnx (for text detection), one rec.onnx (for text recognition) and the corresponding dict.txt (the model-output-to-character mapping). The mobile (= smaller) models as shipped by OnnxOCR also work quite well.


Quick Start

from ppocr_lite import PPOCRLite

ocr_engine = PPOCRLite()

for result in ocr_engine.run("screenshot.png"):
    print(f"{result.score:.2f}  {result.text}")
    # result.box is a np.ndarray (4, 2) - top-left, top-right, bottom-right, bottom-left

Use Your Own Models

from ppocr_lite import PPOCRLite, ModelConfig
from pathlib import Path

ocr_engine = PPOCRLite(
    ModelConfig(
        det_model=Path("models/PP-OCRv5/det.onnx"),
        rec_model=Path("models/PP-OCRv5/rec.onnx"),
        dict_path=Path("models/PP-OCRv5/dict.txt"),
        cls_model=False,   # skip direction classifier
    )
)

GPU inference

ocr_engine = PPOCRLite(providers=["CUDAExecutionProvider", "CPUExecutionProvider"])

Manage Downloaded Models

A few utility functions are available to configure from and to where models are downloaded:

from ppocr_lite import models

models.set_cache_directory("./my-cache-dir")
models.get_cache_directory()  # -> pathlib.Path

models.list_downloaded_models() # -> list[pathlib.Path]
models.download_default_models()
models.download_model("https://huggingface.co/me/my-repo/resolve/main/my-model.onnx?download=true")

Of course you are entirely free to not use the built-in model management functionality and instead do everything yourself – just configure your engine on initialization as described above.


Optimized Path to Check Whether Text is Present

To efficiently check whether a certain text is present in the image, use this function:

res_first_text, res_second_text = ocr_engine.check_contains(
    "./my-screenshot.png",
    
    # Phrases to look for:
    ["This is some text", "some other text"],
    
    # Optionally, position hints can speed up the search by starting to recognize text
    # close to them first; on images with much text, this can be a big boost:
    position_hints=[
        (0.5, 0.5),
        (0.5, 0.6)
    ],
  
    # You can control how far text can be from any given location hint. Text further away than this
    # distance will be ignored; it basically tells the engine how precise your location hints are. 
    # The value is relative to the shorter image side (0 - 1.0):
    position_max_dist=0.3,
    
    # Fuzzy matching is supported; set to zero to disable:
    fuzzy_match_min_similarity=0.8,
)

Design Notes

This project is very similar to the excellent RapidOCR, but more lightweight. Notably, it does not depend on OpenCV (which weighs around 200MB) and uses numpy-based alternatives instead. This does not hurt performance much, at least in my humble tests.

Please be aware that many of those numpy-based alternatives are only really feasible because this project assumes non-distorted input images (screenshots, clean document scans, …). I have not tested it, but I'd assume it doesn't work nearly as well on inputs like perspective-distorted real-world photographs.

What's different here?

  • Detection post-processing – contour finding is replaced with scipy ndimage.label (or a numpy fallback). The minimum-area rectangle is simplified under the assumption of non-perspective distorted input. Polygon offset ("unclip") is done analytically using the area/perimeter ratio and a per-vertex outward push — accurate enough for near-rectangular screenshot text.

  • Resize – PIL BILINEAR instead of cv2.resize. The two are numerically equivalent for the precision required by OCR.

  • Crop – axis-aligned bounding-rect crop instead of a perspective warp. Screenshot text is always axis-aligned, making this lossless.

  • No config YAML, no omegaconf – plain Python dataclasses.

Limitations vs. full PaddleOCR

  • No perspective correction
  • Direction classifier is only a 0°/180° binary; no 90°/270° support.

License

This project is GPL-3.0-or-later licensed. Note that the licenses of models (self-brought or auto-downloaded) will likely differ; refer to their creators for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ppocr_lite-0.5.4.tar.gz (32.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ppocr_lite-0.5.4-py3-none-any.whl (33.4 kB view details)

Uploaded Python 3

File details

Details for the file ppocr_lite-0.5.4.tar.gz.

File metadata

  • Download URL: ppocr_lite-0.5.4.tar.gz
  • Upload date:
  • Size: 32.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ppocr_lite-0.5.4.tar.gz
Algorithm Hash digest
SHA256 5a1e4187c228928f33919adf38984c0e59aff82fafd75935a0888cf11f89f430
MD5 421c1c4bdb84ed2b1fe24102d6663450
BLAKE2b-256 9538887c6e4ab022f1ba2948dce3fbe34c2cb96d0fbebbf22dba8019ffc6adf2

See more details on using hashes here.

Provenance

The following attestation bundles were made for ppocr_lite-0.5.4.tar.gz:

Publisher: python-publish.yml on mityax/ppocr_lite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ppocr_lite-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: ppocr_lite-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 33.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ppocr_lite-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0bedbea07fbc1d6a2f019ea818a2ea09084434d33f783086e254bbabd888000c
MD5 3c4cea09e727dc24fae8a169895423e4
BLAKE2b-256 31bdb759e06f03636d2efc92d5f68b61a3a658c02bc7abd515225886b6473b49

See more details on using hashes here.

Provenance

The following attestation bundles were made for ppocr_lite-0.5.4-py3-none-any.whl:

Publisher: python-publish.yml on mityax/ppocr_lite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page