adding examples + documentation

README.md

@@ -9,4 +9,20 @@ app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# [Mosquito Alert Competition 2023](https://www.aicrowd.com/challenges/mosquitoalert-challenge-2023) - 7th Place Solution
+
+Welcome to my Hugging Face Space showcasing the performance of our model.
+
+This competition focused on detecting and classifying various mosquito species. 
+
+The target species were:
+- **Aedes aegypti** - Species
+- **Aedes albopictus** - Species
+- **Anopheles** - Genus
+- **Culex** - Genus (Species classification is challenging, so it is provided at the genus level)
+- **Culiseta** - Genus
+- **Aedes japonicus/Aedes koreicus** - Species complex (Differentiating between these two species is particularly challenging).
+
+## Experiment Details
+
+All the details regarding the experiments and source code for the models can be found in the [GitHub repository](https://github.com/HCA97/Mosquito-Classifiction/tree/main).

app.py

@@ -1,3 +1,5 @@
+import os
+
 import gradio as gr
 import numpy as np
 import cv2
@@ -30,7 +32,28 @@ def detect_mosquito(image):
     return annotated_image(image, label, conf, bbox)
 
 
+description = """# [Mosquito Alert Competition 2023](https://www.aicrowd.com/challenges/mosquitoalert-challenge-2023) - 7th Place Solution
+
+Welcome to my Hugging Face Space showcasing the performance of our model.
+
+This competition focused on detecting and classifying various mosquito species. 
+
+The target species were:
+- **Aedes aegypti** - Species
+- **Aedes albopictus** - Species
+- **Anopheles** - Genus
+- **Culex** - Genus (Species classification is challenging, so it is provided at the genus level)
+- **Culiseta** - Genus
+- **Aedes japonicus/Aedes koreicus** - Species complex (Differentiating between these two species is particularly challenging).
+
+## Experiment Details
+
+All the details regarding the experiments and source code for the models can be found in the [GitHub repository](https://github.com/HCA97/Mosquito-Classifiction/tree/main).
+"""
+
 iface = gr.Interface(
-    fn=detect_mosquito, inputs=gr.Image(), outputs=gr.Image(), allow_flagging="never"
+    fn=detect_mosquito, description=description, inputs=gr.Image(), outputs=gr.Image(), allow_flagging="never", 
+    examples=[os.path.join("examples", f) for f in os.listdir("examples")],
+    cache_examples=True
 )
 iface.launch()