litealpr 0.1.0__tar.gz

litealpr-0.1.0/.gitignore

@@ -0,0 +1,42 @@
+# Python and Environment
+__pycache__/
+.ipynb_checkpoints/
+*.py[cod]
+*$py.class
+*.so
+env/
+venv/
+.env
+
+# Build and Distribution
+build/
+dist/
+*.egg-info/
+
+# IDE and OS
+.vscode/
+.idea/
+*.DS_Store
+*.vs
+*.user
+*~
+
+# Logs and Outputs
+*.log
+output/
+inference/
+inference_results/
+e2e_results/
+rec_results/
+det_results/
+test_output/
+gradio_outputs/
+
+# Data and Models
+dataset/
+train_data/
+train_data_lmdb/
+pretrained_models/
+*.pt
+*.pth
+*.safetensors

litealpr-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

litealpr-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+
+# Include all Python files
+recursive-include litealpr *.py
+
+# Include dictionary files
+recursive-include litealpr *.txt

litealpr-0.1.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.4
+Name: litealpr
+Version: 0.1.0
+Summary: Accurate and Efficient General OCR System for License Plates
+Home-page: https://github.com/vn-anhnth/LiteALPR
+Author: vn-anhnth
+Author-email: vn-anhnth <anhlone3@gmail.com>
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/vn-anhnth/LiteALPR
+Project-URL: Documentation, https://github.com/vn-anhnth/LiteALPR/tree/main/docs
+Project-URL: Bug Reports, https://github.com/vn-anhnth/LiteALPR/issues
+Keywords: ocr,license plate recognition,yolov8,svtr,deep learning,computer vision
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<2.0
+Requires-Dist: opencv-python<=5.0.0.93
+Requires-Dist: pyyaml<=6.0.3
+Requires-Dist: huggingface-hub<=0.31
+Requires-Dist: torch>=1.7.0
+Requires-Dist: torchvision
+Requires-Dist: ultralytics<=8.3.99
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# LiteALPR
+
+[![PyPI version](https://badge.fury.io/py/litealpr.svg)](https://pypi.org/project/litealpr/)
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/vn-anhnth/LiteALPR/main/docs/figures/intro1.png" width="350">
+  <br>
+  <em>Visual samples of challenging real-world license plates (motion blur, diverse layouts, low light) that LiteALPR is built to handle.</em>
+</p>
+
+🚀 **LiteALPR** is an accurate, extremely fast, and flexible End-to-End License Plate Recognition library.
+
+Unlike traditional ALPR systems that rely on heavy architectures, LiteALPR introduces structural improvements designed specifically for high-throughput applications. Our framework achieves ultra-fast inference speeds without sacrificing accuracy on blurry or degraded license plates through two major architectural optimizations.
+
+## 🧩 LiteALPR Pipeline
+The framework is structured as a highly optimized two-stage sequential pipeline:
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/vn-anhnth/LiteALPR/main/docs/figures/Hung_0060.png" height="150"> ➔ <b>YOLOv8n-Efficient</b> ➔ <img src="https://raw.githubusercontent.com/vn-anhnth/LiteALPR/main/docs/figures/Hung_0060_crop.png" height="150"> ➔ <b>SVTR26-Tiny</b> ➔ <code>59P289136</code>
+</p>
+<p align="center"><em>Overview of the proposed highly optimized two-stage ALPR pipeline.</em></p>
+
+### 1. YOLOv8n-Efficient for Fast Detection
+We replaced the **original heavy C2f blocks** in the YOLOv8 neck with **lightweight C3Ghost blocks**.
+
+| Original: Heavy C2f Block | Proposed: Lightweight C3Ghost Block |
+| :---: | :---: |
+| <img src="https://raw.githubusercontent.com/vn-anhnth/LiteALPR/main/docs/figures/generate_c2f.png" height="250"> | <img src="https://raw.githubusercontent.com/vn-anhnth/LiteALPR/main/docs/figures/generate_c3ghost.png" height="250"> |
+
+Leveraging Ghost modules, this architectural enhancement significantly increases detection speed while maintaining high localization accuracy. By generating more feature maps from cheap operations, it eliminates computational redundancy, enabling ultra-fast performance on consumer-grade hardware without compromising precision.
+
+### 2. SVTR26-Tiny for Lightning-Fast Recognition
+To make the SVTR26 OCR model viable for strict high-speed constraints, we applied a key modification:
+* **Efficient RCTC Decoder:** We entirely discarded the **Original heavy attention-based RCTC Decoder**. Since license plates have a rigid, horizontally aligned structure, we replaced 2D attention with a simple **Height-wise Average Pooling** operation. This elegantly compresses the 2D features into a 1D sequence, completely bypassing expensive matrix multiplications.
+
+| Original: Heavy RCTC Decoder | Proposed: Efficient RCTC Decoder |
+| :---: | :---: |
+| <img src="https://raw.githubusercontent.com/vn-anhnth/LiteALPR/main/docs/figures/original_rctc_decoder.png" width="400"> | <img src="https://raw.githubusercontent.com/vn-anhnth/LiteALPR/main/docs/figures/efficient_rctc_decoder.png" width="400"> |
+
+By integrating these specialized components, **LiteALPR** delivers unmatched production-ready performance, processing frames at blazing speeds!
+
+---
+
+## 🛠 Installation
+
+```bash
+pip install litealpr
+```
+
+*(Note: To use the auto-download feature for pre-trained weights, please ensure `huggingface_hub` is installed).*
+
+## ⚡ Quick Start
+
+LiteALPR automatically downloads the best pre-trained models from our HuggingFace repository the first time you run it. You don't need to manually configure any paths!
+
+### 1. End-to-End Recognition (Detect & Read)
+
+```python
+from litealpr import LiteALPR
+
+# Initialize (auto-downloads weights if not found)
+model = LiteALPR()
+
+# Read the plate
+results = model.read('sample.jpg')
+
+for res in results:
+    print(f"Plate Text: {res['text']} | Confidence: {res['score']:.4f}")
+    print(f"Bounding Box: {res['box']}")
+```
+
+### 2. Flexible API: Detect Only
+If you only need to locate the license plates without reading the text:
+```python
+# Disable the recognition model
+model = LiteALPR(use_rec=False)
+boxes = model.detect('sample.jpg')
+print("Detected boxes:", boxes)
+```
+
+### 3. Flexible API: Recognize Only
+If you already have a cropped image of a license plate and just want to read the characters:
+```python
+# Disable the detection model
+model = LiteALPR(use_det=False)
+
+crop_img = cv2.imread('sample_crop.jpg')
+text, score = model.recognize(crop_img)
+print(f"Text: {text} (Score: {score})")
+```
+
+### 4. Using Custom Local Weights
+If you have fine-tuned your own models or downloaded the weights locally, you can easily load them:
+```python
+model = LiteALPR(
+    det_model_path="/path/to/your/yolov8n_efficient/best.pt",
+    rec_model_path="/path/to/your/svtr26_tiny/best.pth"
+)
+```
+
+## 🏋️ Training & Evaluation
+
+LiteALPR provides a complete suite of scripts in the `tools/` directory for dataset preparation, training, evaluation, and inference.
+
+### 0. Model Weights Preparation
+Before training or evaluation, download the official pre-trained models from our [HuggingFace Repository](https://huggingface.co/anhone3/LiteALPR) and place them in the following structure:
+```
+LiteALPR/
+├── pretrained_models/
+│   ├── yolov8n_efficient/
+│   │   └── best.pt
+│   └── svtr26_tiny/
+│       └── best.pth
+```
+You can download them manually or use `wget`:
+```bash
+wget -O pretrained_models/det/yolov8n_efficient/best.pt https://huggingface.co/anhone3/LiteALPR/resolve/main/yolov8n_efficient/best.pt
+wget -O pretrained_models/rec/svtr26_tiny/best.pth https://huggingface.co/anhone3/LiteALPR/resolve/main/svtr26_tiny/best.pth
+```
+
+### 1. Data Preparation (Create LMDB)
+Because our LMDB script uses hardcoded paths for simplicity, please open `tools/create_lmdb_dataset.py` and modify the `data_dir` variable in the `__main__` block to match your dataset path before running:
+```python
+if __name__ == '__main__':
+    data_dir = './dataset/rec' # Set your dataset directory
+
+    label_file_list = [
+        os.path.join(data_dir, 'train_labels.txt'),
+        os.path.join(data_dir, 'val_labels.txt'),
+        os.path.join(data_dir, 'test_labels.txt')
+    ]
+```
+After modifying the paths, generate the LMDB:
+```bash
+python tools/create_lmdb_dataset.py
+```
+
+### 2. Training (Det & Rec)
+Before training, you must configure your dataset paths, batch sizes, and learning parameters:
+
+**For Detection:**
+Open `tools/train_det.py` and modify the parameters inside the `model.train()` function directly:
+```python
+model.train(
+    data='dataset/det/data.yaml', # Point this to your YOLO data.yaml
+    epochs=50,
+    batch=256,
+    ...
+)
+```
+
+**For Recognition (`configs/rec/svtr26/svtr26_tiny.yml`):**
+```yaml
+Train:
+  dataset:
+    name: RatioDataSetTVResize
+    data_dir_list: ['./dataset/rec/lmdb_data/train']
+
+Eval:
+  dataset:
+    name: RatioDataSetTVResize
+    data_dir_list: ['./dataset/rec/lmdb_data/val']
+```
+
+Once configured, start training:
+
+> [!TIP]
+> **Pre-trained Models (Fine-tuning)**
+> By default, the training process will load pre-trained weights to speed up convergence. You can change the path or remove it to train from scratch:
+> - **For Detection:** Edit the `.load(...)` path directly inside the `tools/train_det.py` script.
+> - **For Recognition:** Edit the `Global.pretrained_model` field inside your `.yml` config file (e.g., `configs/rec/svtr26/svtr26_tiny.yml`).
+
+```bash
+# Train Detection Model (YOLOv8)
+# For multi-GPU training, set device to a list of GPU IDs in train_det.py, e.g., device=[0, 1]
+python tools/train_det.py -c configs/det/yolov8/yolov8n_efficient.yml
+
+# Train Recognition Model (SVTR26)
+# For multi-GPU training, set nproc_per_node to the number of GPUs being used for training
+torchrun --nproc_per_node=1 tools/train_rec.py \
+    -c configs/rec/svtr26/svtr26_tiny.yml
+```
+
+### 3. Evaluation (Validation)
+Evaluate your trained checkpoints on the validation set:
+```bash
+# Evaluate Detection
+python tools/eval_det.py -m output/det/yolov8n_efficient/train/weights/best.pt
+
+# Evaluate Recognition
+python tools/eval_rec.py -c configs/rec/svtr26/svtr26_tiny.yml -m output/rec/svtr26_tiny/train/best.pth
+```
+
+### 4. Batch Inference
+Test your checkpoints directly on directories of images (supports `--save_log` to save predictions):
+```bash
+# Infer Detection
+python tools/infer_det.py -m pretrained_models/det/yolov8n_efficient/best.pt -d dataset/det/test/images --save_log
+
+# Infer Recognition
+python tools/infer_rec.py -m pretrained_models/rec/svtr26_tiny/best.pth -d dataset/rec/test --save_log
+```
+
+### 5. Export to ONNX
+Export your trained PyTorch models to the ONNX format for deployment in production environments (C++, C#, TensorRT, etc.).
+
+```bash
+# Export Detection
+# The ONNX file will automatically be saved alongside the original `.pt` file
+python tools/export_det.py -m output/det/yolov8n_efficient/train/weights/best.pt
+
+# Export Recognition
+# By default, the SVTR ONNX model expects a fixed 128x32 image. If you need it to accept dynamic width images in production, add the `--dynamic` flag
+python tools/export_rec.py -m output/rec/svtr26_tiny/train/best.pth --save_path output/rec/svtr26_tiny/train/best.onnx --dynamic
+```
+
+## 🤝 Acknowledgements
+
+- **OpenOCR**: LiteALPR is built upon the robust foundation of [OpenOCR](https://github.com/Topdu/OpenOCR).
+- **YOLOv8 & SVTRv2**: This work heavily leverages the architectural innovations from **YOLOv8** for high-speed object detection and **SVTRv2** for accurate text recognition.
+  - Read the [YOLOv8 Paper](https://arxiv.org/html/2408.15857v1)
+  - Read the [SVTRv2 Paper](https://arxiv.org/html/2411.15858v1)
+- **Datasets**: Our evaluation utilizes datasets from [Brazil (RodoSol-ALPR)](https://github.com/raysonlaroca/rodosol-alpr-dataset), [China (CBLPRD-330k)](https://github.com/SunlifeV/CBLPRD-330k), and [Vietnam](https://www.kaggle.com/datasets/duydieunguyen/licenseplates) public collections alongside self-collected traffic footage. We sincerely thank the original authors of these datasets for advancing the ALPR research community.
+
+## 📧 Contact
+For any questions or issues, please open an issue or contact: `anhlone3@gmail.com`.