AurevinP commited on
Commit
5c7b65a
·
verified ·
1 Parent(s): eb66daa

addreadme.

Browse files
Files changed (1) hide show
  1. README.md +56 -3
README.md CHANGED
@@ -1,3 +1,56 @@
1
- ---
2
- license: mit
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ tags:
4
+ - yolov8
5
+ - object-detection
6
+ - computer-vision
7
+ - sports-analytics
8
+ - football
9
+ datasets:
10
+ - roboflow
11
+ ---
12
+
13
+ # ⚽ P.U.L.S.E AI Detection Models
14
+
15
+ These are the official pre-trained object detection models for **[P.U.L.S.E AI (Positional & Universal Live Statistical Engine)](https://github.com/AurevinP/PULSE_AI)**.
16
+
17
+ They are based on the Ultralytics YOLOv8 architecture and fine-tuned specifically for football (soccer) analytics.
18
+
19
+ ## Available Models
20
+
21
+ | Filename | Base Model | Purpose |
22
+ |---|---|---|
23
+ | [ball_tracker_200_epoch_92L_25M.pt](AurevinP/PULSE_AI_Models/ball_tracker_200_epoch_92L_25M.pt) | YOLOv8 | Detects and tracks the football on the pitch. |
24
+ | [yolov8s_player_tracker.pt](AurevinP/PULSE_AI_Models/yolov8s_player_tracker.pt) | YOLOv8s | Detects players, goalkeepers, and referees. |
25
+
26
+ > **Note:** The team clustering model (SigLIP + UMAP + KMeans) used by P.U.L.S.E AI is trained dynamically from the input video at runtime and does not require pre-downloaded weights.
27
+
28
+ ## How to Use with P.U.L.S.E AI
29
+
30
+ If you are using the P.U.L.S.E AI repository, these models will be downloaded automatically when you run the pipeline setup, or you can download them manually using the built-in script:
31
+
32
+ ```bash
33
+ # From the root of the PULSE AI repository:
34
+ python download_models.py
35
+ ```
36
+
37
+ ## Manual Python Usage
38
+
39
+ If you wish to use these weights independently of the main P.U.L.S.E AI pipeline, you can load them directly via the `ultralytics` library:
40
+
41
+ ```python
42
+ from huggingface_hub import hf_hub_download
43
+ from ultralytics import YOLO
44
+
45
+ # 1. Download the ball tracker
46
+ ball_model_path = hf_hub_download(
47
+ repo_id="AurevinP/PULSE_AI_Models",
48
+ filename="ball_tracker_200_epoch_92L_25M.pt"
49
+ )
50
+
51
+ # 2. Load into YOLO
52
+ model = YOLO(ball_model_path)
53
+
54
+ # 3. Run inference
55
+ results = model("path/to/football_video.mp4")
56
+ ```