Skip to content

README.md

Latest commit

 

History

History
246 lines (180 loc) · 10.3 KB

README.md

File metadata and controls

246 lines (180 loc) · 10.3 KB
title Vision Intelligence Pro
emoji 🚀
colorFrom indigo
colorTo blue
sdk gradio
app_file app.py
pinned false

ML CI

Custom Vision Transformer (ViT) fine-tuned for your own classes using google/vit-base-patch16-224. A dynamic framework that supports any number of classes—no hardcoded labels.

Overview

This project:

  1. Uses the pre-trained google/vit-base-patch16-224 model
  2. Dynamically infers classes by scanning ./data: each subfolder name becomes a class (e.g. my_cat, my_dog, my_car, …)
  3. Modifies the model from 1000 ImageNet classes to N custom classes (N = number of subfolders)
  4. Trains on your images with augmentation, stratified train/val split, and a mostly frozen ViT (classifier + last two encoder blocks trainable)
  5. Tests with confidence scores, uncertainty detection, and prediction overlays
  6. Provides a Gradio web UI for interactive inference

You can use 5 classes, 10 classes, or any number—just add one folder per class under ./data.

New Features

  • Data augmentation — Training uses RandomResizedCrop(224), RandomHorizontalFlip, and ColorJitter. Validation uses deterministic Resize(224, 224) only. Transforms are applied in the dataset when loading each image.
  • Stratified 80/20 train/val split — Uses sklearn.model_selection.train_test_split with stratify=labels so train and validation keep the same class proportions. Split is done on file paths before building datasets.
  • Confidence scores and uncertainty detection — Inference applies softmax and reports label: XX.X%. When the top confidence is below 90%, the script prints the top 2 classes and their percentages so you can see ambiguity.
  • Gradio web UI — Run python main.py for a browser interface: upload an image, get a Label with Confidence Score and an Image with prediction overlay. Example images from data/ are preloaded for quick testing.

Model Performance

Metrics below are tied to the current ./data/ layout and the files in ./archive/results/, which are rewritten automatically when you run python train.py (see src/models/train.py).

Metric (validation) Value Source
Trainer eval_accuracy 79.59% archive/results/eval_summary.json
sklearn classification_report accuracy 80% (rounded) archive/results/validation_per_class.csv / training log
Macro F1 0.73 archive/results/validation_per_class.csv
Weighted F1 0.78 archive/results/validation_per_class.csv

After an earlier data audit, removing noisy examples (especially in my_house / my_phone) helped lift validation accuracy from about ~51% into the ~80% band on the curated set. The latest logged run lands at 79.59% on 49 validation images (stratified 80/20, random_state=42).

Gradio UI — run python main.py for quick visual checks on new photos.

Data audit (house vs. dog)

Some scraped images confused my_house and my_dog (dogs framed against buildings, ambiguous outdoor shots, or houses labeled like pet thumbnails). Manually removing or re-homing those files reduced label noise and stabilized metrics. See COMPREHENSIVE_RESULTS.md for the full narrative and tables.

Dataset size snapshot (this repo)

Counts are image files per folder under ./data/ (also in archive/results/dataset_split.csv):

Class Images
my_car 60
my_cat 60
my_dog 60
my_house 46
my_phone 16
Total 242

Note on my_phone: the folder holds 16 images. With the stratified split above, 13 are used for training and 3 for validation—so “13” matches the training count for phones, not the on-disk total.

Setup

Install dependencies:

pip install -r requirements.txt

Quick Start

Step 1: Prepare your dataset

Organize images in one folder per class under ./data. Folder names = class names.

data/
  my_cat/
    image1.jpg
    ...
  my_dog/
    ...
  my_car/
  my_house/
  my_phone/

Supported formats: .jpg, .jpeg, .png, .bmp, .gif. Add as many classes as you want.

Step 2: Create the custom model

This scans ./data and builds a model with one output per class:

python model_custom.py

Creates ./custom_vit_model with N classes (N = number of subfolders in ./data). No code change needed when you add or remove classes.

Step 3: Train

python train.py --data_dir ./data --epochs 30 --batch_size 8

Options: --data_dir, --model_path, --output_dir, --epochs, --batch_size, --learning_rate. Training uses an 80% train / 20% validation stratified split, logs validation accuracy each epoch, prints a per-class classification_report at the end, and writes archive/results/dataset_split.csv, archive/results/validation_per_class.csv, and archive/results/eval_summary.json. By default, weights are saved under models/checkpoint-final/ (see TRAINED_MODEL_DIR).

Step 4: Test (CLI)

Single image (prints confidence, top-2 if uncertain, saves overlay):

python test.py --image my_photo.jpg

Directory of images:

python test.py --directory ./my_test_photos

Custom overlay path:

python test.py --image photo.jpg --output result.jpg

Step 5: Test (Web UI)

Launch the Gradio app (loads model from models/checkpoint-final/):

python main.py

Open the URL shown in the terminal (e.g. http://127.0.0.1:7860). Upload an image to get:

  • Label with Confidence Score (e.g. my_cat: 98.5%)
  • Image with prediction overlay (label + confidence drawn on the image)

Use the Examples (one image per class from data/) to try the model immediately.

Usage Summary

Command Description
python model_custom.py Build custom model from ./data class folders
python train.py [--data_dir ./data] [--epochs 30] ... Train; saves weights to models/checkpoint-final/; metrics under ./archive/results/
python test.py --image <path> Single-image test + overlay saved as prediction_output.jpg
python test.py --directory <dir> Batch test; confidence and top-2 when uncertain
python main.py Start Gradio web UI (loads models/checkpoint-final/)
python app.py Same UI on Hugging Face Spaces / explicit checkpoint entry

Documentation

  • README.md — This file (overview, features, usage)
  • USER_GUIDE.md — Step-by-step guide and troubleshooting
  • COMPREHENSIVE_RESULTS.md — Dataset counts, audit notes, validation metrics (aligned with ./archive/results/)

Project Structure

huggingface-image-project/
├── main.py                      # Entry point (launches Gradio UI)
├── app.py                       # HF Spaces entry; loads models/checkpoint-final/
├── model_custom.py              # Wrapper (backward-compatible: python model_custom.py)
├── train.py                     # Wrapper (backward-compatible: python train.py)
├── test.py                      # CLI testing (confidence, overlay, top-2)
├── requirements.txt              # Dependencies
├── src/                          # Modular code
│   ├── __init__.py
│   ├── api/
│   │   ├── __init__.py
│   │   └── inference.py        # Shared inference & overlay logic
│   ├── models/
│   │   ├── __init__.py
│   │   ├── model_custom.py    # Dynamic model creation (N classes from ./data)
│   │   └── train.py           # Training (augmentation, stratified split, frozen backbone)
│   ├── web/
│   │   ├── __init__.py
│   │   └── app.py             # Gradio UI (imports from src.api.inference)
│   └── utils/
│       ├── __init__.py
│       ├── paths.py          # Project root/data/model path helpers
│       └── download_images_loremflickr.py
├── README.md                    # This file
├── USER_GUIDE.md                # Detailed user guide
├── COMPREHENSIVE_RESULTS.md     # Results and analysis (tables ↔ ./archive/results/)
├── models/
│   └── checkpoint-final/      # Fine-tuned weights (HF format); default train output + app load path
├── archive/                     # Old checkpoints, archived `results/`, optional `custom_vit_model` copy
├── .gitignore
├── custom_vit_model/          # Created by model_custom.py (not in git; optional)
└── data/                      # Your images, one subfolder per class (not in git)
    ├── my_cat/
    ├── my_dog/
    ├── my_car/
    ├── my_house/
    └── my_phone/

Complete Workflow

pip install -r requirements.txt
python model_custom.py
python train.py --data_dir ./data --epochs 30
python test.py --image my_photo.jpg
python main.py   # optional: web UI

Customization (technical)

  • Base model: google/vit-base-patch16-224 (ViT, 224×224, 768-d)
  • Change: Final layer Linear(768, 1000) → Linear(768, N); id2label / label2id from class names
  • Training: Most of the ViT backbone is frozen; the classifier and last two encoder layers are trainable (see src/models/train.py)
  • Data: Stratified 80% train / 20% validation; training augmentation, validation resize-only

Tips

  • Use at least 50–100 images per class when possible
  • Keep similar proportions across classes for best stratified split
  • Reduce --batch_size (e.g. 4 or 8) if you run out of memory

Troubleshooting

  • No images found — Ensure data/<class_name>/ exists and filenames use supported extensions.
  • Model not found — Run python model_custom.py first; then train so models/checkpoint-final/ exists before test.py or main.py.
  • Out of memory — Use a smaller --batch_size in train.py.

Requirements

  • Python 3.8+
  • See requirements.txt (PyTorch, Transformers, Gradio, scikit-learn, Pillow, etc.)

License

This project uses the google/vit-base-patch16-224 model from Hugging Face.