SebastianAndreu commited on
Commit
0e9ddac
·
verified ·
1 Parent(s): 2abf59b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -0
README.md CHANGED
@@ -11,4 +11,42 @@ license: mit
11
  short_description: Stop Sign Image Identification
12
  ---
13
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
11
  short_description: Stop Sign Image Identification
12
  ---
13
 
14
+ # Stop Sign Image Classifier
15
+
16
+ **Author:** Your Name
17
+ **Course:** 24679 - Designing and Deploying AI/ML Systems
18
+
19
+ This app classifies traffic images into two categories using an AutoGluon-trained model:
20
+ - **0 = Not a Stop Sign**
21
+ - **1 = Stop Sign**
22
+
23
+ The interface allows you to upload or drag-and-drop an image of a road scene. The model outputs the predicted class along with probability scores.
24
+
25
+ ---
26
+
27
+ ## How to Use
28
+ 1. Upload an image (JPG/PNG).
29
+ 2. Click **Submit** to run the classifier.
30
+ 3. View the predicted label (`0` or `1`) and the probability distribution.
31
+
32
+ ---
33
+
34
+ ## Deployment Details
35
+ - **Frameworks:** [AutoGluon Image](https://auto.gluon.ai/stable/tutorials/image_prediction/index.html), [Gradio](https://gradio.app/)
36
+ - **Hosting:** Hugging Face Spaces
37
+ - **Model Loading:** Model is downloaded from the Hugging Face Hub and automatically unpacked on startup.
38
+
39
+ ---
40
+
41
+ ## Requirements
42
+ Dependencies are listed in `requirements.txt`.
43
+
44
+ ---
45
+
46
+ ## Acknowledgments
47
+ - Model trained by a classmate in Homework 2
48
+ - Deployment scaffold and documentation supported with AI assistance (ChatGPT, OpenAI)
49
+ - Reference: Class-provided notebook *image gradio.ipynb*
50
+
51
+
52
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference