Fast & Lightweight OCR for vehicle license plates.
Project description
Fast & Lightweight License Plate OCR
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 🧠
- Augmentation Variety: Diverse training-time augmentations via Albumentations library 🖼️
- 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 🛠️
- 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 or TFLite 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-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 |
[!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]
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-xs-v1-global-model')
print(m.run('test_plate.png'))
Run demo
To run model benchmark:
from fast_plate_ocr import LicensePlateRecognizer
m = LicensePlateRecognizer('cct-xs-v1-global-model')
m.benchmark()
Benchmark demo
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]
For full details on data preparation, model configs, fine-tuning, and training commands, check out the docs.
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:
- Clone repo
git clone https://github.com/ankandrew/fast-plate-ocr.git
- Install all dependencies (make sure you have Poetry installed):
make install
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fast_plate_ocr-1.0.1.tar.gz
.
File metadata
- Download URL: fast_plate_ocr-1.0.1.tar.gz
- Upload date:
- Size: 43.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
f8bcc168aca3a96e51f30b457f3a405227151ba84beeb3a16fcc168205cca59d
|
|
MD5 |
8458ce43fccfe181ce7b3d10cfa1f789
|
|
BLAKE2b-256 |
db34b8cb13067745fcfffaace7ce5ac8ee39a34549c89685bef49e2e7e53fc9a
|
Provenance
The following attestation bundles were made for fast_plate_ocr-1.0.1.tar.gz
:
Publisher:
release.yaml
on ankandrew/fast-plate-ocr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
fast_plate_ocr-1.0.1.tar.gz
-
Subject digest:
f8bcc168aca3a96e51f30b457f3a405227151ba84beeb3a16fcc168205cca59d
- Sigstore transparency entry: 264567719
- Sigstore integration time:
-
Permalink:
ankandrew/fast-plate-ocr@8a3c5af74d022bb93ccb5cf0b3728c8f149bfe5d
-
Branch / Tag:
refs/tags/v1.0.1
- Owner: https://github.com/ankandrew
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
release.yaml@8a3c5af74d022bb93ccb5cf0b3728c8f149bfe5d
-
Trigger Event:
push
-
Statement type:
File details
Details for the file fast_plate_ocr-1.0.1-py3-none-any.whl
.
File metadata
- Download URL: fast_plate_ocr-1.0.1-py3-none-any.whl
- Upload date:
- Size: 53.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
baa0297801d352b06a1ce2bae8be47c57bfa15fc0bf0d6c4a0caeef503b71176
|
|
MD5 |
d40c10f8d84ce6b9a2a752498aa2f9bd
|
|
BLAKE2b-256 |
2ad9c3feeee217ecc8e06da06247997aa6a8022214ef7dbf558f1ce03dc82706
|
Provenance
The following attestation bundles were made for fast_plate_ocr-1.0.1-py3-none-any.whl
:
Publisher:
release.yaml
on ankandrew/fast-plate-ocr
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1
-
Predicate type:
https://docs.pypi.org/attestations/publish/v1
-
Subject name:
fast_plate_ocr-1.0.1-py3-none-any.whl
-
Subject digest:
baa0297801d352b06a1ce2bae8be47c57bfa15fc0bf0d6c4a0caeef503b71176
- Sigstore transparency entry: 264567720
- Sigstore integration time:
-
Permalink:
ankandrew/fast-plate-ocr@8a3c5af74d022bb93ccb5cf0b3728c8f149bfe5d
-
Branch / Tag:
refs/tags/v1.0.1
- Owner: https://github.com/ankandrew
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com
-
Runner Environment:
github-hosted
-
Publication workflow:
release.yaml@8a3c5af74d022bb93ccb5cf0b3728c8f149bfe5d
-
Trigger Event:
push
-
Statement type: