Skip to main content

Fast & Lightweight OCR for vehicle license plates.

Project description

Fast & Lightweight License Plate OCR

Actions status Actions status Keras 3 image image Ruff Pylint Checked with mypy ONNX Model Hugging Face Spaces Documentation Status image

Intro


Introduction

Lightweight and fast OCR models for license plate text recognition. You can train models from scratch or use the trained models for inference.

The idea is to use this after a plate object detector, since the OCR expects the cropped plates.

Features

  • Keras 3 Backend Support: Train seamlessly using TensorFlow, JAX, or PyTorch backends 🧠
  • Efficient Execution: Lightweight models that are cheap to run 💰
  • ONNX Runtime Inference: Fast and optimized inference with ONNX runtime
  • User-Friendly CLI: Simplified CLI for training and validating OCR models 🛠️
  • Region Recognition (Optional): Predict region/country of the license plate 🌍
  • Model HUB: Access to a collection of pre-trained models ready for inference 🌟
  • Train/Fine-tune: Easily train or fine-tune your own models 🔧
  • Export-Friendly: Export easily to CoreML, TFLite, or ONNX formats 📦

Available Models

Optimized, ready to use models with config files for inference or fine-tuning.

Model Name Size Arch b=1 Avg. Latency (ms) Plates/sec (PPS) Model Config Plate Config Val Results
cct-s-v2-global-model S CCT 0.6758 1479.61 model_config.yaml plate_config.yaml results
cct-xs-v2-global-model XS CCT 0.4664 2144.14 model_config.yaml plate_config.yaml results
cct-s-v1-global-model S CCT 0.5877 1701.63 model_config.yaml plate_config.yaml results
cct-xs-v1-global-model XS CCT 0.3232 3094.21 model_config.yaml plate_config.yaml results

[!TIP] 🚀 Try the above models in Hugging Spaces.

[!NOTE] Benchmark Setup

These results were obtained with:

  • Hardware: NVIDIA RTX 3090 GPU
  • Execution Providers: ['TensorrtExecutionProvider', 'CUDAExecutionProvider', 'CPUExecutionProvider']
  • Install dependencies: pip install fast-plate-ocr[onnx-gpu]

Explore the Model Zoo to see all available models.

Inference

For doing inference, install:

pip install fast-plate-ocr[onnx-gpu]

By default, no ONNX runtime is installed. To run inference, you must install at least one ONNX backend using an appropriate extra.

Platform/Use Case Install Command Notes
CPU (default) pip install fast-plate-ocr[onnx] Cross-platform
NVIDIA GPU (CUDA) pip install fast-plate-ocr[onnx-gpu] Linux/Windows
Intel (OpenVINO) pip install fast-plate-ocr[onnx-openvino] Best on Intel CPUs
Windows (DirectML) pip install fast-plate-ocr[onnx-directml] For DirectML support
Qualcomm (QNN) pip install fast-plate-ocr[onnx-qnn] Qualcomm chipsets

Usage

To predict from disk image:

from fast_plate_ocr import LicensePlateRecognizer

m = LicensePlateRecognizer('cct-s-v2-global-model')
print(m.run('test_plate.png'))

If your model includes a region head (and plate_regions is defined in the plate config), predictions also include region. The region_prob field is populated when return_confidence=True:

from fast_plate_ocr import LicensePlateRecognizer

m = LicensePlateRecognizer('cct-s-v2-global-model')
pred = m.run('test_plate.png', return_confidence=True)[0]
print(pred.region, pred.region_prob)

To run a model benchmark:

from fast_plate_ocr import LicensePlateRecognizer

m = LicensePlateRecognizer('cct-s-v2-global-model')
m.benchmark()

For more examples and the full API, see the Inference Guide and Reference.

Training

You can train models from scratch or fine-tune a pre-trained one using your own license plate dataset.

Install the training dependencies:

pip install fast-plate-ocr[train]

Fine-tuning Tutorial

A complete tutorial notebook is available for fine-tuning a license plate OCR model on your own dataset: examples/fine_tune_workflow.ipynb. It covers the full workflow, from preparing your dataset to training and exporting the model.

For full details on data preparation, model configs, fine-tuning, and training commands, check out the docs.

For region recognition and export-friendly activations, use the v2 models.

Contributing

Contributions to the repo are greatly appreciated. Whether it's bug fixes, feature enhancements, or new models, your contributions are warmly welcomed.

To start contributing or to begin development, you can follow these steps:

  1. Clone repo
    git clone https://github.com/ankandrew/fast-plate-ocr.git
    
  2. Install all dependencies (make sure you have uv installed):
    make install
    
  3. To ensure your changes pass linting and tests before submitting a PR:
    make checks
    

Citations

@article{hassani2021escaping,
    title   = {Escaping the Big Data Paradigm with Compact Transformers},
    author  = {Ali Hassani and Steven Walton and Nikhil Shah and Abulikemu Abuduweili and Jiachen Li and Humphrey Shi},
    year    = 2021,
    url     = {https://arxiv.org/abs/2104.05704},
    eprint  = {2104.05704},
    archiveprefix = {arXiv},
    primaryclass = {cs.CV}
}

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

fast_plate_ocr-1.1.0.tar.gz (316.0 kB view details)

Uploaded Source

Built Distribution

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

fast_plate_ocr-1.1.0-py3-none-any.whl (62.3 kB view details)

Uploaded Python 3

File details

Details for the file fast_plate_ocr-1.1.0.tar.gz.

File metadata

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

File hashes

Hashes for fast_plate_ocr-1.1.0.tar.gz
Algorithm Hash digest
SHA256 911054d56b89d95ad6e56eae898a1c981a98d86510e4674595805de233645aa2
MD5 cd7c4938c8363a5b33620429788681a7
BLAKE2b-256 ab230cf6a5d271e539c4660044b875eae6ef2fd26e682359d05b504f6e953bc1

See more details on using hashes here.

Provenance

The following attestation bundles were made for fast_plate_ocr-1.1.0.tar.gz:

Publisher: release.yaml on ankandrew/fast-plate-ocr

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

File details

Details for the file fast_plate_ocr-1.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for fast_plate_ocr-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 98eba340ab90a04cf5daa693320942ce7eeb5977529143df6bb41afd08239062
MD5 2282f87ca270ba27f3eece7a7c67153a
BLAKE2b-256 a5e9c806e94c98826234c5d04f1591cb9ed18f09a54c9a0fd907c0e0d7537468

See more details on using hashes here.

Provenance

The following attestation bundles were made for fast_plate_ocr-1.1.0-py3-none-any.whl:

Publisher: release.yaml on ankandrew/fast-plate-ocr

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