Updated Readme

.dockerignore

@@ -0,0 +1,4 @@
+data/*
+README.MD
+notebooks/*
+.gitignore

Dockerfile

@@ -0,0 +1,23 @@
+# Get the base image
+FROM python:3.8-slim-buster
+
+#Expose port 8080
+# EXPOSE 8080
+
+#Copy Requirements.txt file into app directory
+COPY requirements.txt app/requirements.txt
+
+#install all requirements in requirements.txt
+RUN pip install -r app/requirements.txt
+
+#Copy all files in current directory into app directory
+COPY . /app
+
+#Change Working Directory to app directory
+WORKDIR /app
+
+# Run the application on port 8080 for Local Host or GCP
+# ENTRYPOINT ["streamlit", "run", "app.py", "--server.port 8080", "--server.address 0.0.0.0"]
+
+# Heroku Startup Command
+CMD streamlit run app.py --server.port $PORT

README.md

@@ -1,43 +1,47 @@
 ---
 tags:
-- image-classification
-- pytorch
-- huggingpics
+  - image-classification
+  - pytorch
+  - huggingpics
 metrics:
-- accuracy
+  - accuracy
 
 model-index:
-- name: big-cat-classifier
-  results:
-  - task:
-      name: Image Classification
-      type: image-classification
-    metrics:
-      - name: Accuracy
-        type: accuracy
-        value: 0.9107142686843872
+  - name: big-cat-classifier
+    results:
+      - task:
+          name: Image Classification
+          type: image-classification
+        metrics:
+          - name: Accuracy
+            type: accuracy
+            value: 0.9107142686843872
 ---
 
+![Big Cat Classifier](./assets/banner_img.png)
 
+An image classifier built using Vision Transformers that categories images of the big cats into the following classes:
 
-# Big Cat Classifier 🐯
+| Class | Big Cat | Sample Image                     |
+| :---: | :------ | -------------------------------- |
+|   0   | Cheetah | ![cheetah](./assets/cheetah.jpg) |
+|   1   | Jaguar  | ![jaguar](./assets/jaguar.jpg)   |
+|   2   | Leopard | ![leopard](./assets/leopard.jpg) |
+|   3   | Lion    | ![lion](./assets/lion.jpg)       |
+|   4   | Tiger   | ![tiger](./assets/tiger.jpg)     |
 
-An image classifier built using Vision Transformers that categories images of the big cats into the following classes:
+> **Note**:
+>
+> - Since jaguars and leopards have similar appearances, the model might confuse the two. These [[1](https://www.nationalgeographic.com/animals/article/animals-big-cats-jaguars-leopards)] [[2](https://safarisafricana.com/jaguar-v-leopard/)] two articles throw some light on the difference between the two species.
+> - Theoretically the model should be able to accurately identify geographical population variants of each species. However, in practical scenarios this may not be true as during the training phases this was not kept in mind while collecting the dataset.
+>   - For example: images of Bengal Tigers, Siberian Tigers, Indochinese Tigers, and Malayan Tigers should be identified as Tigers
+> - Lastly, the performance of the model in categorizing certain rare variants in the populations of big cats such as white tigers, snow leopards, or black panther has not been determined exclusively. Although some of the tests performed gave satisfactory results.
 
-|Class| Big Cat |Sample Image|
-|:---:|:--------|-------------------------------|
-|  0  | Cheetah |![cheetah](./images/cheetah.jpg) |
-|  1  | Jaguar  |![jaguar](./images/jaguar.jpg)   |
-|  2  | Leopard |![leopard](./images/leopard.jpg) |
-|  3  | Lion    |![lion](./images/lion.jpg)       | 
-|  4  | Tiger   |![tiger](./images/tiger.jpg)     |
+### Training and Inference
 
+**Training**: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/smaranjitghose/Big_Cat_Classifier/blob/master/notebooks/Big_Cat_Classifier.ipynb)
 
-> __Note__:
-> - Since jaguars and leopards have similar appearances, the model might confuse the two. These [[1](https://www.nationalgeographic.com/animals/article/animals-big-cats-jaguars-leopards)] [[2](https://safarisafricana.com/jaguar-v-leopard/)] two articles throw some light on the difference between the two species.
-> - Theoretically the model should be able to accurately identify geographical population variants of each species. However, in practical scenarios this may not be true as during the training phases this was not kept in mind while collecting the dataset.  
->    - For example: images of Bengal Tigers, Siberian Tigers, Indochinese Tigers, and Malayan Tigers should be identified as Tigers
-> - Lastly, the performance of the model in categorizing certain rare variants in the populations of big cats such as white tigers, snow leopards, or black panther has not been determined exclusively. Although some of the tests performed gave satisfactory results. 
+**Inference**: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/smaranjitghose/Big_Cat_Classifier/blob/master/notebooks/Big_Cat_Classifier_Inference.ipynb)
 
 ## Usage
 
@@ -58,13 +62,121 @@ def identify_big_cat(img_path:str)->str:
   logits = outputs.logits
   predicted_class_idx = logits.argmax(-1).item()
   return model_panthera.config.id2label[predicted_class_idx]
- 
+
 
  our_big_cat = identify_big_cat("path_of_the_image")
  print(f"Predicted species: {our_big_cat}" )
 ```
 
+## Hosted API:
+
+Check it out [here](https://huggingface.co/smaranjitghose/big-cat-classifier)
+
+## Library App Usage:
+
+- Clone this repository
+
+```
+git clone https://github.com/smaranjitghose/Big_Cat_Classifier.git
+```
+
+- Move inside the cloned repository
+
+```
+cd Big_Cat_Classifier
+```
+
+- Now follow either of following two routes:
+
+A) Without using Docker:
+
+**Make sure you have installed the latest stable version [Python 3](https://www.python.org/downloads/) and added it to PATH**
+
+- Install the python dependencies
+
+```
+pip install -r requirements.txt
+```
+
+- Start the streamlit app on local server
+
+```
+streamlit run app.py
+```
+
+B) Using Docker:
+
+**Make sure you have installed [Docker](https://docs.docker.com/engine/install/)**
+
+- Build the Docker Image
+
+```
+docker build -t smaranjitghose/big-cat-classifier:latest .
+```
+
+- Check if the image is available
+
+```
+docker images
+```
+
+- Create a Docker container from the image and Run it
+
+```
+docker run -t -i -p 8080:8080 --name "big-cat-classifier" smaranjitghose/big-cat-classifier
+```
+
+- Open your browser and visit `localhost:8080`
+
+![Streamlit App](./assets/streamlit_app.png)
+
+## Hosting
+
+1. Heroku
+
+- Remove the lines that exposed the particular port in the docker container
+- Make sure the startup command is exposed with a variable Port Number
+
+```
+ENTRYPOINT ["streamlit", "run", "app.py", "--server.port=$PORT"]
+```
+
+- Login to Heroku
+
+```
+heroku login -i
+```
+
+- Create a new Heroku app
+
+```
+heroku create
+```
+
+- Login in to Container Registry
+
+```
+heroku container:login
+```
+
+- Build the Docker image and push it to Container Registry
+
+```
+heroku container:push web
+```
+
+- Release the app
+
+```
+heroku container:release web
+```
+
+- Check the hosted version and dashboard
+
+```
+heroku open
+```
+
 ## Reference and Acknowledgement:
 
 [Hugging Pics](https://github.com/nateraw/huggingpics)
-

app.py

@@ -0,0 +1,45 @@
+import time
+
+import streamlit as st
+from PIL import Image, ImageOps
+
+from src import big_cat_classifier
+
+
+def main():
+    st.set_page_config(
+        page_title="Big Cat Classifier",
+        layout="centered",
+        initial_sidebar_state="collapsed",
+    )
+    banner_img = Image.open("./assets/banner_img.png")
+    st.image(banner_img)
+    st.title("Coded with ❤️ by Smaranjit Ghose")
+    st.text("")
+    st.text("")
+    st.text("")
+
+    uploaded_file = st.file_uploader("Choose an image..", type=["jpg", "png", "jpeg"])
+
+    if st.button("Predict"):
+        if uploaded_file is not None:
+            try:
+                img = Image.open(uploaded_file)
+                st.subheader("Your Image:")
+                st.image(img)
+                st.write("")
+                st.write("")
+
+                with st.spinner("Our AI forest officer has started analyzing...."):
+                    label = big_cat_classifier.classifier(uploaded_file)
+                    time.sleep(5)
+                    st.success(f"We think this is an image of a {label}")
+
+            except:
+                st.error("We apologize something went wrong 🙇🏽‍♂️")
+        else:
+            st.error("Can you please upload an image 🙇🏽‍♂️")
+
+
+if __name__ == "__main__":
+    main()

app.yaml

@@ -0,0 +1,9 @@
+service: big-cat-classifier
+runtime: custom
+env: flex
+manual_scaling: 
+  instances: 1
+resources:
+  cpu: 1
+  memory_gb: 0.5
+  disk_size_gb: 10

src/big_cat_classifier.py

@@ -0,0 +1,20 @@
+from PIL import Image
+from transformers import ViTFeatureExtractor, ViTForImageClassification
+
+
+def classifier(img_path: str) -> str:
+    """
+    Function that reads an image of a big cat (belonging to Panthera family) and returns the corresponding species
+    """
+    img = Image.open(img_path)
+    model_panthera = ViTForImageClassification.from_pretrained(
+        "smaranjitghose/big-cat-classifier"
+    )
+    feature_extractor = ViTFeatureExtractor.from_pretrained(
+        "smaranjitghose/big-cat-classifier"
+    )
+    inputs = feature_extractor(images=img, return_tensors="pt")
+    outputs = model_panthera(**inputs)
+    logits = outputs.logits
+    predicted_class_idx = logits.argmax(-1).item()
+    return model_panthera.config.id2label[predicted_class_idx]