Spaces:
Sleeping
Sleeping
Docs: Polish README user guide
Browse files
README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
| 3 |

|
| 4 |
|
| 5 |
## Overview
|
| 6 |
-
Annotation Assistant is a state-of-the-art **Vision-Language Object Detection** tool. It combines the power of **Qwen-VL (4B)** with a
|
| 7 |
|
| 8 |
Unlike standard detection tools, this assistant is **conversational**. You can refine detections naturally (e.g., *"Also find the cup"*), and the AI intelligently merges new findings with existing ones.
|
| 9 |
|
|
@@ -15,25 +15,37 @@ The Assistant remembers what it has already found.
|
|
| 15 |
* **Example**: If you say *"Find the laptop"* and then *"Find the remaining objects"*, it understands what "remaining" means because it knows the laptop is already detected.
|
| 16 |
|
| 17 |
### 🎯 **Smart Refinement Logic**
|
| 18 |
-
|
| 19 |
* **Refinement**: If you draw a better box for `"shirt"` over an existing one (>80% overlap), it **replaces** the old one.
|
| 20 |
-
* **
|
| 21 |
* Result: NO duplicate ghost boxes, NO accidental deletions.
|
| 22 |
|
| 23 |
### 👁️ **Explainable AI (Reasoning)**
|
| 24 |
Don't just trust the box. The Assistant provides a **Reasoning Stream** explaining *why* it detected an object.
|
| 25 |
* *Example*: "Detected silver laptop due to distinct Apple logo and metallic finish."
|
| 26 |
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
|
| 32 |
-
|
| 33 |
-
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 37 |
|
| 38 |
---
|
| 39 |
*Built with Streamlit, Qwen-VL, and ❤️.*
|
|
|
|
| 3 |

|
| 4 |
|
| 5 |
## Overview
|
| 6 |
+
Annotation Assistant is a state-of-the-art **Vision-Language Object Detection** tool. It combines the power of **Qwen-VL (4B)** with a user-friendly interface to make labeled data creation effortless.
|
| 7 |
|
| 8 |
Unlike standard detection tools, this assistant is **conversational**. You can refine detections naturally (e.g., *"Also find the cup"*), and the AI intelligently merges new findings with existing ones.
|
| 9 |
|
|
|
|
| 15 |
* **Example**: If you say *"Find the laptop"* and then *"Find the remaining objects"*, it understands what "remaining" means because it knows the laptop is already detected.
|
| 16 |
|
| 17 |
### 🎯 **Smart Refinement Logic**
|
| 18 |
+
I implemented a custom **Weighted Merge Algorithm** to handle updates:
|
| 19 |
* **Refinement**: If you draw a better box for `"shirt"` over an existing one (>80% overlap), it **replaces** the old one.
|
| 20 |
+
* **Distinct Objects**: If you seek a second `"shirt"` elsewhere (low overlap), it **adds** it as a new object.
|
| 21 |
* Result: NO duplicate ghost boxes, NO accidental deletions.
|
| 22 |
|
| 23 |
### 👁️ **Explainable AI (Reasoning)**
|
| 24 |
Don't just trust the box. The Assistant provides a **Reasoning Stream** explaining *why* it detected an object.
|
| 25 |
* *Example*: "Detected silver laptop due to distinct Apple logo and metallic finish."
|
| 26 |
|
| 27 |
+
## How to Run
|
| 28 |
+
|
| 29 |
+
### ☁️ Option 1: Google Colab (Recommended for Free GPU)
|
| 30 |
+
1. Open the `Colab_Runner.ipynb` file in Google Colab.
|
| 31 |
+
2. Upload `app.py`, `utils.py`, and `requirements.txt` to the Colab files area.
|
| 32 |
+
3. Add your **Ngrok Authtoken** in the designated cell.
|
| 33 |
+
4. Run all cells. The app will launch via a public URL.
|
| 34 |
+
|
| 35 |
+
### 💻 Option 2: Local System (Requires GPU)
|
| 36 |
+
1. **Clone the Repo**:
|
| 37 |
+
```bash
|
| 38 |
+
git clone https://github.com/devsingh02/Pixel-Prompt-Annotator.git
|
| 39 |
+
cd Pixel-Prompt-Annotator
|
| 40 |
+
```
|
| 41 |
+
2. **Install Dependencies**:
|
| 42 |
+
```bash
|
| 43 |
+
pip install -r requirements.txt
|
| 44 |
+
```
|
| 45 |
+
3. **Run the App**:
|
| 46 |
+
```bash
|
| 47 |
+
streamlit run app.py
|
| 48 |
+
```
|
| 49 |
|
| 50 |
---
|
| 51 |
*Built with Streamlit, Qwen-VL, and ❤️.*
|