luthrabhuvan commited on
Commit
917538d
Β·
verified Β·
1 Parent(s): aee9a5c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +60 -0
README.md CHANGED
@@ -11,3 +11,63 @@ license: mit
11
  ---
12
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  ---
12
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
14
+
15
+ # 🧠 Brain Tumor Detection using YOLOv8 🎯
16
+
17
+ ## πŸš€ Overview
18
+ This **Hugging Face Space** allows users to **upload MRI scan images** and detect the presence of a **brain tumor** using the **YOLOv8** object detection model. The model processes the uploaded image and provides an annotated output indicating whether a tumor is detected.
19
+
20
+ πŸ”Ή **Built with:** `YOLOv8` | `Gradio` | `PyTorch` | `OpenCV`
21
+ πŸ”Ή **Live on Hugging Face Spaces!** βœ…
22
+
23
+ ## ✨ Features
24
+ βœ”οΈ **Upload MRI scan images** πŸ₯
25
+ βœ”οΈ **YOLOv8-powered brain tumor detection** 🧠
26
+ βœ”οΈ **Annotated image output with tumor detection** πŸ“Έ
27
+ βœ”οΈ **Real-time diagnosis message** ⏳
28
+ βœ”οΈ **Simple & intuitive UI powered by Gradio** 🎨
29
+
30
+ ---
31
+
32
+ ## πŸ›  How to Use
33
+ 1️⃣ **Upload an MRI image** by clicking the "Upload MRI Image" button.
34
+ 2️⃣ **Click "Submit"** to analyze the image.
35
+ 3️⃣ **View the results**:
36
+ - The uploaded MRI image with **bounding boxes** (if a tumor is detected).
37
+ - A **diagnosis message** ("Tumor Detected" or "No Tumor Detected").
38
+
39
+ βœ… **No installation required!** Just visit the Hugging Face Space and start detecting brain tumors instantly.
40
+
41
+ ---
42
+
43
+ ## πŸ“ Model Details
44
+ This app uses **YOLOv8**, an advanced object detection model fine-tuned for **brain tumor detection**.
45
+ - **Default model:** `yolov8n.pt` (Replace with `best.pt` for custom-trained model).
46
+ - **Bounding box output** with confidence score.
47
+ - **Fast & accurate inference** using PyTorch.
48
+
49
+ ---
50
+
51
+ ## πŸ— Deployment on Hugging Face Spaces
52
+ ### **1️⃣ Create a New Hugging Face Space**
53
+ Go to **[Hugging Face Spaces](https://huggingface.co/spaces)** and create a new **Gradio** Space.
54
+
55
+ ### **2️⃣ Upload the following files:**
56
+ - **`app.py`** (Main Gradio app)
57
+ - **`requirements.txt`** (Dependencies)
58
+ - **`model/best.pt`** (Your trained YOLOv8 model)
59
+
60
+ ### **3️⃣ Run the Space!**
61
+ Hugging Face will **automatically install dependencies** and deploy the app.
62
+
63
+ ---
64
+
65
+ ## πŸ“œ Dependencies (Auto-installed in Hugging Face)
66
+ ```text
67
+ gradio
68
+ torch
69
+ torchvision
70
+ ultralytics
71
+ opencv-python
72
+ numpy
73
+