adolfzcoder MiguelEscamilla commited on
Commit
a2ef6a9
·
0 Parent(s):

Duplicate from MiguelEscamilla/id-card-yolo

Browse files

Co-authored-by: MIguel Escamilla <MiguelEscamilla@users.noreply.huggingface.co>

Files changed (3) hide show
  1. .gitattributes +35 -0
  2. README.md +98 -0
  3. best.pt +3 -0
.gitattributes ADDED
@@ -0,0 +1,35 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.bin filter=lfs diff=lfs merge=lfs -text
4
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
5
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
6
+ *.ftz filter=lfs diff=lfs merge=lfs -text
7
+ *.gz filter=lfs diff=lfs merge=lfs -text
8
+ *.h5 filter=lfs diff=lfs merge=lfs -text
9
+ *.joblib filter=lfs diff=lfs merge=lfs -text
10
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
12
+ *.model filter=lfs diff=lfs merge=lfs -text
13
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
14
+ *.npy filter=lfs diff=lfs merge=lfs -text
15
+ *.npz filter=lfs diff=lfs merge=lfs -text
16
+ *.onnx filter=lfs diff=lfs merge=lfs -text
17
+ *.ot filter=lfs diff=lfs merge=lfs -text
18
+ *.parquet filter=lfs diff=lfs merge=lfs -text
19
+ *.pb filter=lfs diff=lfs merge=lfs -text
20
+ *.pickle filter=lfs diff=lfs merge=lfs -text
21
+ *.pkl filter=lfs diff=lfs merge=lfs -text
22
+ *.pt filter=lfs diff=lfs merge=lfs -text
23
+ *.pth filter=lfs diff=lfs merge=lfs -text
24
+ *.rar filter=lfs diff=lfs merge=lfs -text
25
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
26
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
27
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
28
+ *.tar filter=lfs diff=lfs merge=lfs -text
29
+ *.tflite filter=lfs diff=lfs merge=lfs -text
30
+ *.tgz filter=lfs diff=lfs merge=lfs -text
31
+ *.wasm filter=lfs diff=lfs merge=lfs -text
32
+ *.xz filter=lfs diff=lfs merge=lfs -text
33
+ *.zip filter=lfs diff=lfs merge=lfs -text
34
+ *.zst filter=lfs diff=lfs merge=lfs -text
35
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,98 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ tags:
4
+ - object-detection
5
+ - computer-vision
6
+ - yolo
7
+ - id-card
8
+ - document-ai
9
+ - pytorch
10
+ - onnx
11
+ library_name: ultralytics
12
+ pipeline_tag: object-detection
13
+ ---
14
+
15
+ # ID Card Object Detection Model (YOLO)
16
+
17
+ ## 📌 Overview
18
+
19
+ This model is a YOLO-based object detection model trained to detect regions on ID card images such as:
20
+
21
+ - ID card boundaries
22
+ - Face / portrait region
23
+ - Barcodes / QR codes
24
+ - Text regions / structured fields (depending on dataset)
25
+
26
+ The model is intended for:
27
+ - Document processing pipelines
28
+ - OCR preprocessing and region extraction
29
+ - Identity verification workflows
30
+ - Computer vision research and prototyping
31
+
32
+ The model outputs bounding boxes, class labels, and confidence scores.
33
+
34
+ ---
35
+
36
+ ## 🚀 How to Use
37
+
38
+ ### Python (Ultralytics)
39
+
40
+ ```python
41
+ from ultralytics import YOLO
42
+
43
+ model = YOLO('best.pt')
44
+ results = model.predict('image.jpg', conf=0.25)
45
+ results[0].show()
46
+ ```
47
+
48
+ ### Download from Hugging Face
49
+
50
+ ```python
51
+ from huggingface_hub import hf_hub_download
52
+
53
+ model_path = hf_hub_download(repo_id='miguelescamilla/id-card-yolo', filename='best.pt')
54
+ ```
55
+
56
+ ---
57
+
58
+ ## 🧠 Model Details
59
+
60
+ - Architecture: YOLO (Ultralytics)
61
+ - Framework: PyTorch
62
+ - Input size: 640×640 (default)
63
+ - Task: Object Detection
64
+ - Outputs:
65
+ - Bounding boxes (xyxy)
66
+ - Class IDs
67
+ - Confidence scores
68
+
69
+ ---
70
+
71
+ ## ⚠️ Limitations
72
+
73
+ - Performance depends on image quality, lighting, and camera perspective.
74
+ - Accuracy is limited by the size and diversity of the training dataset.
75
+ - Not validated for safety-critical or regulated environments.
76
+
77
+ ---
78
+
79
+ ## 📜 License & Credits
80
+
81
+ ### Model Weights
82
+ This repository contains trained model weights uploaded by the author.
83
+
84
+ ### YOLO Framework Credit
85
+ This model was trained using **Ultralytics YOLO**, licensed under the **AGPL-3.0 license**.
86
+
87
+ **Important:** If you use this model in commercial or proprietary systems, you must comply with Ultralytics licensing terms or obtain a commercial license.
88
+
89
+ Ultralytics Links:
90
+ - https://github.com/ultralytics/ultralytics
91
+ - https://www.ultralytics.com
92
+
93
+ ---
94
+
95
+ ## 👤 Author
96
+
97
+ Uploaded by: miguelescamilla
98
+ Last updated: 2026-01-12
best.pt ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:03242ba44d7a495e54bbdb56517eec74cbf2123e00185cf17027f2a5ab8bf204
3
+ size 6249258