azizerorahman commited on
Commit
d919cfb
Β·
verified Β·
1 Parent(s): 59cb1b6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -56
README.md CHANGED
@@ -1,69 +1,31 @@
1
  ---
2
- title: VisioTrack Object Tracker
3
  emoji: 🎯
4
  colorFrom: blue
5
  colorTo: purple
6
- sdk: gradio
7
- sdk_version: 3.50.2
8
- app_file: app.py
9
  pinned: false
10
  license: mit
11
  ---
12
 
13
- # VisioTrack - SiamRPN Object Tracker
14
 
15
- Real-time object tracking using SiamRPN (Siamese Region Proposal Network) with GPU acceleration.
16
 
17
- ## πŸš€ Features
18
 
19
- - **GPU-accelerated tracking** - Fast processing with CUDA support
20
- - **Easy-to-use interface** - Simple bounding box input
21
- - **First frame preview** - See your video before tracking
22
- - **Progress tracking** - Real-time progress updates
23
- - **Download results** - Get your tracked video instantly
24
 
25
- ## πŸ“– How to Use
26
 
27
- 1. **Upload Video** - Click to upload your video file
28
- 2. **View First Frame** - Preview appears automatically
29
- 3. **Define Bounding Box** - Enter coordinates:
30
- - X: Left edge position
31
- - Y: Top edge position
32
- - Width: Box width
33
- - Height: Box height
34
- 4. **Start Tracking** - Click the button and wait
35
- 5. **Download** - Save your tracked video
36
-
37
- ## 🎯 Tips for Best Results
38
-
39
- - Use clear, high-contrast objects
40
- - Ensure good lighting in your video
41
- - Start with a tight bounding box around the object
42
- - Avoid extreme motion blur
43
- - Test with shorter videos first
44
-
45
- ## πŸ› οΈ Technical Details
46
-
47
- - **Model**: SiamRPN (Siamese Region Proposal Network)
48
- - **Framework**: PyTorch
49
- - **Interface**: Gradio 3.50.2
50
- - **Dataset**: GOT-10k
51
- - **Backend**: OpenCV for video processing
52
-
53
- ## πŸ“ Example Coordinates
54
-
55
- For a 1920x1080 video:
56
- - **Person in center**: X=800, Y=300, W=300, H=600
57
- - **Car on left**: X=200, Y=400, W=400, H=300
58
- - **Face close-up**: X=700, Y=200, W=500, H=500
59
-
60
- ## ⚠️ Limitations
61
-
62
- - Works best with single object tracking
63
- - May lose track with extreme occlusion
64
- - Performance depends on object appearance changes
65
- - GPU recommended for longer videos
66
-
67
- ## πŸ“„ License
68
-
69
- MIT License - Feel free to use and modify!
 
1
  ---
2
+ title: VisioTrack API
3
  emoji: 🎯
4
  colorFrom: blue
5
  colorTo: purple
6
+ sdk: docker
 
 
7
  pinned: false
8
  license: mit
9
  ---
10
 
11
+ # VisioTrack - FastAPI Object Tracking API
12
 
13
+ REST API for real-time object tracking using SiamRPN.
14
 
15
+ ## API Endpoints
16
 
17
+ - `GET /` - Interactive API documentation (Swagger UI)
18
+ - `GET /health` - Health check
19
+ - `POST /track` - Track object in video
20
+ - `GET /info` - API usage information
 
21
 
22
+ ## Usage Example
23
 
24
+ ```bash
25
+ curl -X POST "https://your-space-url.hf.space/track" \
26
+ -F "video=@your_video.mp4" \
27
+ -F "bbox_x=100" \
28
+ -F "bbox_y=100" \
29
+ -F "bbox_w=200" \
30
+ -F "bbox_h=200" \
31
+ -o tracked_output.mp4