Add application file, models, support files

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.autopep8"
+    },
+    "python.formatting.provider": "none"
+}

README.md

@@ -1,13 +1,85 @@
+# Birds 525 Species Detector
 ---
-title: Birds 525 Species Detector
-emoji: 🐢
-colorFrom: green
-colorTo: gray
-sdk: streamlit
-sdk_version: 1.26.0
-app_file: app.py
-pinned: false
-license: other
----
+## 1. Load Data
+[**BIRDS 525 SPECIES IMAGE CLASSIFICATION DATASET**](https://www.kaggle.com/datasets/gpiosenka/100-bird-species)
+- **Dataset Size:** 525 bird species.
+- **Images:** 84,635 training images, 2,625 test images (5 per species), and 2,625 validation images (5 per species).
+- **Image Dimensions:** 224x224x3 JPG format.
+- **Data Structure:** Convenient subdirectories for each species.
+- **Additional File:** `birds.csv` contains file paths, class labels, and more.
+
+**Dataset Quality:**
+- Cleaned to remove duplicate and low-quality images.
+- Each image features a single bird taking up at least 50% of pixels.
+- Original images, no augmentation.
+
+**File Naming:**
+- Sequential numbering, e.g., "001.jpg," "002.jpg" for training.
+- Test and validation images: "1.jpg" to "5.jpg."
+
+**Note:** Training set not balanced but has ≥130 images per species.
+
+## 2. Data Preparation
+**Augmentation Transforms:**
+- Imported augmentation transforms to enhance dataset diversity.
+
+**Item Transforms:**
+- Images resized to a consistent width of 460 pixels.
+
+**Batch Transforms:**
+- Images resized to 224x224 pixels with a minimum scaling of 75%.
+- Additional augmentations applied to batches for robustness.
+
+These transformations ensure data consistency and introduce variability, preparing the dataset for model training.
+
+## 3. Create DataLoader
+**DataBlock Configuration:**
+- Utilized Fastai's DataBlock to define data processing.
+- Blocks specified as (ImageBlock, CategoryBlock) for image and category data.
+- `get_items` set to retrieve image files.
+- Splitter configured using `GrandparentSplitter` to separate train and test sets based on directory names.
+- `get_y` method defined to extract parent label as category.
+- Item and batch transforms (`item_tfms` and `batch_tfms`) applied as configured.
+
+**DataLoaders Creation:**
+- Fastai DataLoaders created using the DataBlock and dataset path.
+- Batch size set to 64 for efficient data loading.
+
+These steps establish the DataLoaders required for training and validation, making the data ready for model ingestion.
+
+## 4. Create Learner (Model) & Find Learning Rate
+**Pre-trained Model Configuration:**
+- Imported pre-trained ResNet models (resnet34 and resnet50) from torchvision.
+- Created a vision learner using the Fastai library with the ResNet-50 architecture.
+- Enabled the use of pretrained weights and specified evaluation metrics, including accuracy and error rate.
+- Enabled mixed-precision training using `to_fp16()` for enhanced training efficiency.
+
+**Finding Learning Rate:**
+- Utilized the `lr_find()` method to determine an optimal learning rate.
+- Discovered a suitable learning rate range (`lr`) for model training, set as `slice(1e-4, 5e-3)`.
+
+This section highlights the model configuration, including the choice of architecture, pretrained weights, and learning rate discovery, ensuring an effective setup for model training and evaluation.
+
+## 5. Train & Save Model
+**Model Performance with Resnet50 (Freezed Layers)**
+
+| Epoch | Train Loss | Valid Loss | Accuracy | Error Rate | Time   |
+|-------|------------|------------|----------|------------|--------|
+| 0     | 1.2802     | 0.4474     | 0.8705   | 0.1295     | 13:50  |
+| 1     | 0.7865     | 0.1838     | 0.9482   | 0.0518     | 11:06  |
+| 2     | 0.4920     | 0.1074     | 0.9695   | 0.0305     | 11:17  |
+| 3     | 0.3435     | 0.0671     | 0.9844   | 0.0156     | 10:44  |
+| 4     | 0.2979     | 0.0590     | 0.9859   | 0.0141     | 11:12  |
+
+**Model Training:**
+- The model was trained for 5 epochs using a one-cycle learning rate policy with the specified learning rate range.
+- The training results demonstrate the model's impressive performance, achieving high accuracy and low error rates.
+
+**Model Preservation:**
+- Saved the trained model with the name 'model1_freezed' for future use.
+- This step ensures that the model's architecture and learned weights are preserved and can be easily loaded and deployed for various tasks.
+
+This section provides an overview of the model's training performance, including training and validation losses, accuracy, and error rates. It also emphasizes the importance of preserving the trained model for future use.
+
+
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app/app.py

@@ -0,0 +1,75 @@
+# Import streamlit
+import streamlit as st
+from streamlit_option_menu import option_menu
+from fastai.vision.all import *
+from fastai.learner import load_learner
+import pickle
+from bird_species import model_info
+from bird_species import capture_photo
+from bird_species import upload_photo
+
+
+def app():
+    #######################################################################################################################
+
+    # Set the page config
+    st.set_page_config(
+        page_title="Bird 525 Species Detector",  # The title of the web page
+        page_icon="🕊️",  # The icon of the web page, can be an emoji or a file path
+        initial_sidebar_state="collapsed"
+    )
+
+    #######################################################################################################################
+
+    st.markdown("<h1 style='text-align: center;'>🕊️Birds 525 Species Detector🕊️</h1>",
+                unsafe_allow_html=True)
+
+    #######################################################################################################################
+
+    # Options Menu at the top of the homepage
+    selected = option_menu(None, ["Upload", "Capture", "Model"],
+                           icons=["cloud upload", "camera", "gear"],
+                           menu_icon="cast", default_index=0, orientation="horizontal")
+
+    #######################################################################################################################
+
+    # Load model and model class labels (vocab)
+    model = load_learner(fname="models/birds_learner.pkl")
+
+    with open("models/birds_vocab.pkl", "rb") as f:
+        vocab = pickle.load(f)
+    # Sorting
+    vocab = sorted(vocab)
+
+    with open("models/freezed_model_summary.pkl", "rb") as f:
+        freezed_arch_summary = pickle.load(f)
+
+    with open("models/unfreezed_model_summary.pkl", "rb") as f:
+        unfreezed_arch_summary = pickle.load(f)
+
+    #######################################################################################################################
+
+    if selected == "Upload":
+        st.caption("""Our project utilizes FastAI Vision with the ResNet50 architecture to classify 
+                   525 bird species. Our dataset comprises 84,635 training images, 2,625 test images and 2,625 validation 
+                   images, all standardized to 224x224x3 pixels. Initial training yields 96.6% accuracy, improved to 98% post 
+                   fine-tuning. Despite gender imbalances, it's a valuable resource for accurate bird species classification.""")
+
+        upload_photo(model=model, vocab=vocab, key="upload photo")
+
+    #######################################################################################################################
+
+    if selected == "Capture":
+        capture_photo(model=model, vocab=None, key="capture photo")
+
+    if selected == "Model":
+        model_info()
+        st.subheader("FastAi Model Summary (Freezed)")
+        st.code(freezed_arch_summary)
+        st.subheader("FastAi Model Summary (Unfreezed)")
+        st.code(unfreezed_arch_summary)
+
+
+#######################################################################################################################
+if __name__ == "__main__":
+    app()

app/bird_species.py

@@ -0,0 +1,99 @@
+# Import streamlit
+import streamlit as st
+from streamlit_option_menu import option_menu
+from PIL import Image
+import pandas as pd
+from fastai.vision.all import *
+from fastai.learner import load_learner
+
+#######################################################################################################################
+
+def upload_photo(model=None, vocab=None, key=None):
+    options = st.multiselect("**Find & select multiple names, then perform Web Search, Download, Upload & Detect...**",
+                                 vocab,
+                                 vocab[100:108],
+                                 key="birds_detector 1")
+    st.text(f"Your selection: {options}")
+
+    uploaded_image = st.file_uploader(
+        "**Upload an image**", type=["jpg", "png", "jpeg"], key=key)
+    st.divider()
+
+    if uploaded_image:
+        image = Image.open(uploaded_image)
+        st.image(image, use_column_width=True)
+
+        if st.button("**Detect**", type="primary"):
+            output = model.predict(image)
+            st.markdown(f"""
+                            <div style="text-align:center;">
+                            <h1>{output[0]}</h1>
+                            </div>""",
+                        unsafe_allow_html=True)
+
+            st.image(
+                image, caption=f'{output[0]} {max(output[2]).item() * 100:.2f}%', use_column_width=True)
+
+#######################################################################################################################
+
+def capture_photo(model=None, vocab=None, key=None):
+    capture_toggle = st.toggle(
+    label="**`Enable Camera`**", key="birds_capture_photo")
+
+    if capture_toggle:
+        # Check if the cancel checkbox is not selected
+        img_file_buffer = st.camera_input(
+            label="Take a picture (`try to keep the subject at the center`)", key=key)
+
+        if img_file_buffer:
+            # To read image file buffer as a PIL Image:
+            image = Image.open(img_file_buffer)
+
+            st.image(image, use_column_width=True)
+
+            if st.button(label="Detect", key="pets_capture_detect"):
+
+                output = model.predict(image)
+                st.markdown(f"""<div style="text-align:center;">
+                                <h1>{output[0]}</h1>
+                                </div>""",
+                            unsafe_allow_html=True)
+
+                st.image(
+                    image, caption=f'{output[0]} {max(output[2]).item() * 100:.2f}%', use_column_width=True)
+    
+#######################################################################################################################
+
+def model_info():
+    # Model performance on Freezed Layers
+    st.subheader("Model performance with Resnet50 (freezed layers)")
+    freezed_data = {
+        'epoch': [0, 1, 2, 3, 4],
+        'train_loss': [1.280186, 0.786523, 0.491951, 0.343532, 0.297919],
+        'valid_loss': [0.447442, 0.183758, 0.107396, 0.067139, 0.058960],
+        'accuracy': [0.870476, 0.948190, 0.969524, 0.984381, 0.985905],
+        'error_rate': [0.129524, 0.051810, 0.030476, 0.015619, 0.014095],
+        'time': ['13:50', '11:06', '11:17', '10:44', '11:12']
+    }
+
+    df = pd.DataFrame(freezed_data)
+    st.table(df)
+
+    # Model performance on Unfreezed Layers
+    st.subheader("Model performance with Resnet50 (unfreezed layers)")
+    # Create a DataFrame with the provided data
+    unfreezed_data = {
+        'epoch': [0, 1, 2, 3, 4],
+        'train_loss': [0.989004, 0.699652, 0.447756, 0.258508, 0.160852],
+        'valid_loss': [0.391414, 0.176702, 0.089814, 0.037954, 0.029704],
+        'accuracy': [0.896381, 0.949714, 0.975238, 0.991238, 0.992762],
+        'error_rate': [0.103619, 0.050286, 0.024762, 0.008762, 0.007238],
+        'time': ['17:05', '12:41', '12:12', '14:43', '12:30']
+    }
+
+    df = pd.DataFrame(unfreezed_data)
+
+    # Create a Streamlit table
+    st.table(df)
+
+#######################################################################################################################

models/birds_learner.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5c1e6951eb889c8ccc74ce374ad895dbc75729528cb9391869906db7f940281c
+size 105634905

models/birds_vocab.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ba7936fc583eab66f5c0007492366a946ac7d19a411214f04122e97027214238
+size 12695

models/freezed_model_summary.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bdca1fa49df71b40420b42e95803dbc66eb1ddc4bbf304b837099c74e2f7370c
+size 13999

models/unfreezed_model_summary.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e7cf8743aa71a4cbb2a86a7cdf5447b58f5e438dd1438343b00bd5312ac3b79e
+size 13968

requirements.txt

@@ -0,0 +1,3 @@
+fastai
+streamlit
+streamlit-option-menu