Publish FactoryVision AI model package (public review)

README.md

@@ -11,46 +11,71 @@ tags:
 - mobilenetv3
 - education
 ---
-# FactoryVision AI — MobileNetV3-Small Casting Inspector
+# 🏭 FactoryVision AI
+## Casting Inspection · MobileNetV3-Small
 
-**FactoryVision AI — Credits and Attribution**
+> **Educational prototype** · Transfer learning · Binary image classification · **Human review required**
 
-**Original Developer & Model Author:** Theivanth Rajamohan  
-**Technical Review, Code Contributions & Model Publication Support:** [Swapin Vidya](https://huggingface.co/Swapinvidya)  
-**Project Contributor:** [Rajah Shanmugasundaram](https://huggingface.co/rajahshan)  
-**Publishing Organisation:** TechSphere Consultancy Services Private Limited  
-**Hugging Face:** https://huggingface.co/TechsphereAI  
-**Official Website:** https://techsphereconsultancy.com/
+| Model | Task | Framework | Weights |
+|---|---|---|---|
+| FactoryVision AI MobileNetV3-Small | Casting defect classification | PyTorch / torchvision | `model.pth` |
 
-**Project Provenance:** FactoryVision AI was originally developed by Theivanth Rajamohan. [Swapin Vidya](https://huggingface.co/Swapinvidya) contributed technical review, detection-metrics improvements, testing, model publication preparation and documentation. The models are being prepared for publication under TechSphere Consultancy Services Private Limited's Hugging Face namespace, with the original developer's permission.
+## 📊 Held-out test results
 
-**Original GitHub Repository:** https://github.com/Theivanth/Factory-Vision-AI  
-**Merged contribution by [Swapin Vidya](https://huggingface.co/Swapinvidya):** https://github.com/Theivanth/Factory-Vision-AI/pull/1
+| Metric | Reported result |
+|---|---:|
+| Accuracy | **0.9944** |
+| Macro precision | **0.9932** |
+| Macro recall | **0.9948** |
+| Macro F1 | **0.9940** |
+| Mean inference latency | **0.395 ms** |
 
-## Purpose and limitations
-Educational transfer-learning binary casting inspection (`def_front`, `ok_front`). **Human review is required.** Not a validated or certified automated quality acceptance system.
+**Confusion matrix** — rows are true labels, columns are predictions; class order: `def_front`, `ok_front`.
 
-## Architecture and files
-- torchvision MobileNetV3-Small, pretrained backbone and replaced classification head, fine-tuned on casting images
-- Weights: `model.pth` (archive `checkpoints/casting_mobilenet_v3_small.pth`)
+```text
+[[450, 3],
+ [  1, 261]]
+```
+
+Metrics are from the saved training output, not independently reproduced. Latency is environment-specific and is not a deployed CPU benchmark. The test split did not determine architecture selection; the selection metric was validation macro F1.
+
+## 🎯 Purpose and limitations
+
+Educational transfer-learning binary casting inspection (`def_front`, `ok_front`). **Human review is required.** This is not a validated or certified automated quality acceptance system.
+
+## 🧠 Model details
+
+- torchvision MobileNetV3-Small with a pretrained backbone and replaced classification head, fine-tuned on casting images
+- Packaged weights: `model.pth` (archive path `checkpoints/casting_mobilenet_v3_small.pth`)
 - Validation-selected best casting architecture in the supplied manifest: `mobilenet_v3_small`
-- Class order in `labels.json`; for architecture and preprocessing see `src/quality.py` in the source repository
+- Class order: `labels.json`; for architecture and preprocessing see `src/quality.py` in the source repository
+
+## 🗂️ Training data
 
-## Training dataset
-Real-Life Industrial Dataset of Casting Product by Ravirajsinh Dabhi (https://www.kaggle.com/datasets/ravirajsinh45/real-life-industrial-dataset-of-casting-product). The source README identifies CC BY-NC-ND 4.0 dataset restrictions, including non-commercial and no-derivatives clauses. Rights to redistribute trained model weights remain to be confirmed; do not redistribute source images.
+Real-Life Industrial Dataset of Casting Product by Ravirajsinh Dabhi ([Kaggle dataset](https://www.kaggle.com/datasets/ravirajsinh45/real-life-industrial-dataset-of-casting-product)). The source README identifies CC BY-NC-ND 4.0 dataset restrictions, including non-commercial and no-derivatives clauses. Rights to redistribute trained model weights remain to be confirmed; do not redistribute source images.
 
-## Held-out test performance (from supplied Kaggle output)
-- Accuracy: **0.9944**
-- Macro precision: **0.9932**
-- Macro recall: **0.9948**
-- Macro F1: **0.9940**
-- Test confusion matrix (rows true, columns predicted; class order `def_front`, `ok_front`): `[[450, 3], [1, 261]]`
-- Mean inference latency reported by Kaggle: **0.395 ms** (environment-specific, not a deployed CPU benchmark)
+## 🔧 Inference and dependencies
 
-Metrics are from the saved training output, not independently reproduced. The test split did not determine architecture selection; the selection metric was validation macro F1.
+Use the model-loader and preprocessors from `src/quality.py` in the [original GitHub project](https://github.com/Theivanth/Factory-Vision-AI). The checkpoint is a PyTorch artifact, **not** a drop-in Hugging Face Transformers model. Avoid loading untrusted serialized checkpoints.
 
-## Inference and dependencies
-Use the model-loader and preprocessors from `src/quality.py` of https://github.com/Theivanth/Factory-Vision-AI . The checkpoint is a PyTorch artifact, **not** a drop-in Hugging Face Transformers model. Avoid loading untrusted serialized checkpoints.
+## ⚖️ Licensing and distribution
 
-## Licensing and distribution
 The source code's MIT licence is distinct from trained-weight rights. **Keep private until the casting dataset conditions and weight publication rights are clarified.** No public checkpoint licence is asserted.
+
+---
+
+## 🤝 Credits and attribution
+
+| Role | Contributor |
+|---|---|
+| Original Developer & Model Author | Theivanth Rajamohan |
+| Technical Reviewer, Code Contributor & Publication Support | [Swapin Vidya](https://huggingface.co/Swapinvidya) |
+| Project Contributor | [Rajah Shanmugasundaram](https://huggingface.co/rajahshan) |
+| Publishing Organisation | TechSphere Consultancy Services Private Limited |
+
+**Project provenance:** FactoryVision AI was originally developed by Theivanth Rajamohan. [Swapin Vidya](https://huggingface.co/Swapinvidya) contributed technical review, detection-metrics improvements, testing, model publication preparation and documentation. The models are being prepared for publication under TechSphere Consultancy Services Private Limited's Hugging Face namespace, with the original developer's permission.
+
+- 🤗 [TechSphereAI on Hugging Face](https://huggingface.co/TechsphereAI)
+- 🌐 [Official website](https://techsphereconsultancy.com/)
+- 💻 [Original GitHub project](https://github.com/Theivanth/Factory-Vision-AI)
+- 🔀 [Swapin Vidya's merged contribution](https://github.com/Theivanth/Factory-Vision-AI/pull/1)