arturdjuan commited on
Commit
d6af371
Β·
verified Β·
1 Parent(s): 571ee61

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -113
README.md CHANGED
@@ -10,138 +10,38 @@ tags:
10
  - video
11
  - video-summarization
12
  - highlight-detection
13
- - temporal-annotations
14
  homepage: https://ipcv.github.io/SoccerHigh/
15
  repository: https://github.com/IPCV/SoccerHigh
16
  ---
17
 
18
  # ⚽ SoccerHigh
19
 
20
- This code provides the implementation of the **Baseline Model** introduced in:
21
 
22
  [**SoccerHigh: A Benchmark Dataset for Automatic Soccer Video Summarization**](https://dl.acm.org/doi/pdf/10.1145/3728423.3759410)
23
  Artur DΓ­az-Juan, Coloma Ballester, Gloria Haro
24
  ACM MMSports 2025
25
 
26
- ---
27
-
28
- ## πŸ“‚ Code Structure
29
 
30
- The code for the baseline model is organized as follows:
31
-
32
- ```text
33
- code/
34
- β”œβ”€β”€ augmentations/
35
- β”‚ β”œβ”€β”€ mixup.py # Mixup augmentation implementation
36
- β”œβ”€β”€ configs/ # Hydra configuration files
37
- | β”œβ”€β”€ datamodules/
38
- β”‚ | β”œβ”€β”€ default.yaml
39
- | β”œβ”€β”€ datasets/
40
- β”‚ | β”œβ”€β”€ default.yaml
41
- | β”œβ”€β”€ models/
42
- β”‚ | β”œβ”€β”€ default.yaml
43
- | β”œβ”€β”€ scripts/
44
- β”‚ | β”œβ”€β”€ trim_summary.yaml
45
- | β”œβ”€β”€ trainer/
46
- β”‚ | β”œβ”€β”€ default.yaml
47
- | β”œβ”€β”€ predict.yaml
48
- | β”œβ”€β”€ test.yaml
49
- β”‚ β”œβ”€β”€ train.yaml
50
- β”œβ”€β”€ datamodules/
51
- β”‚ β”œβ”€β”€ datamodule.py # Data module handling datasets and dataloaders
52
- β”œβ”€β”€ datasets/
53
- β”‚ β”œβ”€β”€ soccernet_games.py # Handles SoccerNet game-level data
54
- β”‚ β”œβ”€β”€ soccernet_summarization.py # Handles video summarization data
55
- β”‚ β”œβ”€β”€ utils.py # Utility functions for dataset processing
56
- β”œβ”€β”€ evaluation/
57
- β”‚ β”œβ”€β”€ evaluate.py # Compute metrics and summarize model performance
58
- β”œβ”€β”€ inference/
59
- β”‚ β”œβ”€β”€ inference.py # Key shot selection for inference
60
- β”‚ β”œβ”€β”€ utils.py # Helper functions for inference
61
- β”œβ”€β”€ models/
62
- β”‚ β”œβ”€β”€ classifier.py # Baseline model implementation
63
- β”‚ β”œβ”€β”€ dino.py # DINO implementation
64
- β”‚ β”œβ”€β”€ heads.py # Model heads definitions
65
- β”‚ β”œβ”€β”€ transnetv2.py # TransNetv2 implementation
66
- β”œβ”€β”€ scripts/
67
- β”‚ β”œβ”€β”€ trimm_summary.py # Script to compute new summary annotations
68
- β”œβ”€β”€ weights/
69
- β”‚ β”œβ”€β”€ Baseline_VideoMAEv2-Giant.ckpt # Baseline checkpoint using the VideoMAEv2 giant backbone
70
- β”‚ β”œβ”€β”€ Baseline_VideoMAEv2-Small.ckpt # Baseline checkpoint using the VideoMAEv2 small backbone
71
- β”œβ”€β”€ predict.py # Inference script
72
- β”œβ”€β”€ test.py # Testing script
73
- β”œβ”€β”€ train.py # Training script
74
- ```
75
 
76
  ---
77
 
78
- ## βš™οΈ Preparation
79
-
80
- Before running the code, set up the environment and the dataset path.
81
-
82
- **1. Create the Conda environment**:
83
-
84
- We provide an `environment.yml` file to install all dependencies:
85
-
86
- ```bash
87
- conda env create -f environment.yml
88
- conda activate soccerhigh
89
- ```
90
-
91
- **2. Create a symbolic link to the dataset**:
92
-
93
- The code requires a folder named `data` (either a symbolic link or the dataset itself), containing the files from [**SoccerHigh**](https://github.com/IPCV/SoccerHigh/tree/main/dataset).
94
 
95
  ```bash
96
- ln -s /path/to/your/dataset data
 
97
  ```
98
 
99
- Replace `/path/to/your/dataset` with the actual path to your dataset folder.
100
-
101
- ---
102
-
103
- ## πŸš€ Usage
104
-
105
- The code is designed using [PyTorch Lightning](https://lightning.ai/) for cleaner training loops and easier scaling.
106
- All configurations are managed using a [Hydra](https://hydra.cc/), making it easy to modify parameters.
107
-
108
- ### 1. Training
109
-
110
- Train the model using the default configuration:
111
-
112
- ```bash
113
- python3 train.py
114
- ```
115
-
116
- ### 2. Testing/Evaluation
117
-
118
- Evaluate a trained model checkpoint:
119
-
120
- ```bash
121
- python3 test.py checkpoint='weights/checkpoint.ckpt'
122
- ```
123
-
124
- Replace `checkpoint.ckpt` with the actual checkpoint name. Default: [`Baseline_VideoMAEv2-Giant.ckpt`](https://github.com/IPCV/SoccerHigh/blob/main/code/weights/Baseline_VideoMAEv2-Giant.ckpt)
125
-
126
- ### 3. Inference
127
-
128
- Run inference on new games:
129
-
130
- ```bash
131
- python3 predict.py checkpoint='weights/checkpoint.ckpt' output_path='file.json' datamodule.predict.dataset.game_list='/data/games.txt'
132
- ```
133
-
134
- Replace `checkpoint.ckpt`, `file.json` and `games.txt` with the actual file names. Default: [`Baseline_VideoMAEv2-Giant.ckpt`](https://github.com/IPCV/SoccerHigh/blob/main/code/weights/Baseline_VideoMAEv2-Giant.ckpt), `output.json` and `test.txt`
135
-
136
- ---
137
-
138
- ## πŸ”— Notes
139
-
140
- - Make sure the symbolic link `data` points correctly to your dataset.
141
-
142
- - All configuration files are in `configs/` for easy experiment management.
143
-
144
- - Logs and checkpoints will be saved in the default generated directory `lightning_logs/`.
145
 
146
  ---
147
 
 
10
  - video
11
  - video-summarization
12
  - highlight-detection
 
13
  homepage: https://ipcv.github.io/SoccerHigh/
14
  repository: https://github.com/IPCV/SoccerHigh
15
  ---
16
 
17
  # ⚽ SoccerHigh
18
 
19
+ This model card provides the checkpoints for the **Baseline Model** introduced in:
20
 
21
  [**SoccerHigh: A Benchmark Dataset for Automatic Soccer Video Summarization**](https://dl.acm.org/doi/pdf/10.1145/3728423.3759410)
22
  Artur DΓ­az-Juan, Coloma Ballester, Gloria Haro
23
  ACM MMSports 2025
24
 
25
+ ## πŸ“‚ Model Checkpoints
 
 
26
 
27
+ | Name | Description |
28
+ |------|-------------|
29
+ | Baseline_VideoMAEv2-Giant | Baseline model trained with a VideoMAEv2 encoder for feature extraction using [*vit_g_hybrid_pt_1200e_k710_ft*](https://huggingface.co/OpenGVLab/VideoMAE2/resolve/main/distill/vit_s_k710_dl_from_giant.pth) weights |
30
+ | Baseline_VideoMAEv2-Small | Baseline model trained with a VideoMAEv2 encoder for feature extraction using [*vit_g_hybrid_pt_1200e_k710_ft*](https://github.com/OpenGVLab/VideoMAEv2/blob/master/docs/MODEL_ZOO.md) weights |
31
+ | Baseline_CLIP | Baseline model trained with a CLIP encoder for feature extraction using [*CLIP ViT-B-32 256Γ—256 trained on DataComp-1B*](https://huggingface.co/laion/CLIP-ViT-B-32-256x256-DataComp-s34B-b86K) weights |
32
+ | Baseline_ResNet | Baseline model trained with a ResNet-152 encoder for feature extraction using [*IMAGENET1K_V2*](https://docs.pytorch.org/vision/main/models/generated/torchvision.models.resnet152.html#torchvision.models.ResNet152_Weights) weights |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
33
 
34
  ---
35
 
36
+ ## βš™οΈ Installation
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
  ```bash
39
+ git clone https://github.com/IPCV/SoccerHigh.git
40
+ cd SoccerHigh/code
41
  ```
42
 
43
+ For more details, please visit the original repository:
44
+ [https://github.com/IPCV/SoccerHigh](https://github.com/IPCV/SoccerHigh)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
45
 
46
  ---
47