MehdiH7 commited on
Commit
8c6b706
Β·
verified Β·
1 Parent(s): 72361db

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -67
README.md CHANGED
@@ -17,85 +17,49 @@ datasets:
17
  - HockeyAI
18
  ---
19
 
20
- # HockeyAI: A Multi-Class Ice Hockey Dataset for Object Detection
21
 
22
- The **HockeyAI dataset** is an open-source dataset designed specifically for advancing computer vision research in ice hockey. With approximately **2,100 high-resolution frames** and detailed YOLO-format annotations, this dataset provides a rich foundation for tackling the challenges of object detection in fast-paced sports environments.
23
 
24
- The dataset is ideal for researchers, developers, and practitioners seeking to improve object detection and tracking tasks in ice hockey or similar dynamic scenarios.
25
 
26
- ---
27
-
28
- ## Dataset Overview
29
-
30
- The HockeyAI dataset includes frames extracted from **broadcasted Swedish Hockey League (SHL) games**. Each frame is manually annotated, ensuring high-quality labels for both dynamic objects (e.g., players, puck) and static rink elements (e.g., goalposts, center ice).
31
-
32
- ### Classes
33
- The dataset includes annotations for the following seven classes:
34
- - **centerIce**: Center circle on the rink
35
- - **faceoff**: Faceoff dots
36
- - **goal**: Goal frame
37
- - **goaltender**: Goalkeeper
38
- - **player**: Ice hockey players
39
- - **puck**: The small, fast-moving object central to gameplay
40
- - **referee**: Game officials
41
-
42
-
43
- ![image/jpeg](https://cdn-uploads.huggingface.co/production/uploads/647ceb7936e109abce3e9f1f/g7GiPlsOnaV1pPKhzb_Pz.jpeg)
44
-
45
-
46
- ### Key Highlights:
47
- - **Resolution**: 1920Γ—1080 pixels
48
- - **Frames**: ~2,100
49
- - **Source**: Broadcasted SHL videos
50
- - **Annotations**: YOLO format, reviewed iteratively for accuracy
51
- - **Challenges Addressed**:
52
- - Motion blur caused by fast camera movements
53
- - Small object (puck) detection
54
- - Crowded scenes with occlusions
55
-
56
- ---
57
-
58
- ## Applications
59
-
60
- The dataset supports a wide range of applications, including but not limited to:
61
- - **Player and Puck Tracking**: Enabling real-time tracking for tactical analysis.
62
- - **Event Detection**: Detecting goals, penalties, and faceoffs to automate highlight generation.
63
- - **Content Personalization**: Dynamically reframing videos to suit different screen sizes.
64
- - **Sports Analytics**: Improving strategy evaluation and fan engagement.
65
-
66
-
67
- ---
68
 
69
- ## Pretrained Model
70
-
71
- In addition to the dataset, a **YOLOv8 medium model** fine-tuned on the HockeyAI dataset is available. The model achieves high performance across all seven classes and serves as a benchmark for future research. You can access the model by dowloading the pt file under this repo.
72
-
73
- ---
74
-
75
- ## How to Use the Dataset
76
-
77
- 1. Download the dataset from [Hugging Face](https://huggingface.co/your-dataset-link).
78
- 2. The dataset is organized in the following structure:
79
- HockeyAI/ β”œβ”€β”€ frames/ β”‚ β”œβ”€β”€ <Unique_ID>.jpg β”œβ”€β”€ annotations/ β”‚ β”œβ”€β”€ <Unique_ID>.txt
80
 
 
 
 
 
81
 
82
- 3. Each annotation file follows the YOLO format:
83
- <class_id> <x_center> <y_center> <width> <height
84
 
 
 
 
 
85
 
86
- All coordinates are normalized to the image dimensions.
87
 
88
- 4. Use the dataset with your favorite object detection framework, such as YOLOv8 or PyTorch-based solutions.
 
 
 
 
 
 
 
89
 
90
- ---
91
 
92
- ## Key Metrics
 
 
93
 
94
- The model was evaluated on a holdout set of the HockeyAI dataset, achieving the following performance:
95
 
96
- - **Mean Average Precision (mAP@0.5)**: XX.X%
97
- - **Precision**: 100% for all classes
98
- - **Recall**: 95% for all classes
99
- - **F1-Score**: 93% for all classes
100
 
101
 
 
17
  - HockeyAI
18
  ---
19
 
20
+ # HockeyAI YOLOv8 Model
21
 
22
+ ## Model Overview
23
 
24
+ The HockeyAI project provides a **YOLOv8 medium model** fine-tuned on the HockeyAI dataset. This model serves as a benchmark for ice hockey object detection tasks and achieves high performance across all seven classes defined in the dataset.
25
 
26
+ ## Model Performance
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
27
 
28
+ The model was evaluated on a holdout set of the HockeyAI dataset, achieving the following performance metrics:
 
 
 
 
 
 
 
 
 
 
29
 
30
+ - **Mean Average Precision (mAP@0.5)**: XX.X%
31
+ - **Precision**: 100% for all classes
32
+ - **Recall**: 95% for all classes
33
+ - **F1-Score**: 93% for all classes
34
 
35
+ ## Usage
 
36
 
37
+ The pretrained model is available in this repository as a `.pt` file. You can download and use it directly with the YOLOv8 framework for:
38
+ - Inference on new hockey videos or images
39
+ - Further fine-tuning on your specific use case
40
+ - Benchmarking against new approaches
41
 
42
+ ## Supported Classes
43
 
44
+ The model is trained to detect seven classes:
45
+ - Center Ice
46
+ - Faceoff Dots
47
+ - Goal Frame
48
+ - Goaltender
49
+ - Players
50
+ - Puck
51
+ - Referee
52
 
53
+ ## Requirements
54
 
55
+ - YOLOv8 framework
56
+ - Python 3.7+
57
+ - PyTorch 1.7+
58
 
59
+ ## Getting Started
60
 
61
+ 1. Download the model weights from this repository
62
+ 2. Install the required dependencies
63
+ 3. Load and use the model with YOLOv8's standard API
 
64
 
65