Skip to content

Commit 50b864d

Browse files
Update README.md
Update "SoccernetPro" to "VideoAnnotationTool"
1 parent 8c5b58e commit 50b864d

1 file changed

Lines changed: 20 additions & 19 deletions

File tree

README.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# SoccerNetPro Analyzer (UI)
1+
# Video Annotation Tool (UI)
22

33
[![Documentation Status](https://img.shields.io/badge/docs-online-brightgreen)](https://opensportslab.github.io/soccernetpro-ui/)
44

5-
A **PyQt6-based GUI** for analyzing and annotating **SoccerNetPro / action spotting** datasets (OpenSportsLab).
5+
A **PyQt6-based GUI** for analyzing and annotating **OSL format** datasets (OpenSportsLab).
66

77
---
88

99
## Features
1010

11-
- Open and visualize SoccerNetPro-style data and annotations.
11+
- Open and visualize OSL-style data and annotations.
1212
- Annotate and edit events/actions with a user-friendly GUI.
1313
- Manage labels/categories and export results for downstream tasks.
1414
- Easy to extend with additional viewers, overlays, and tools.
@@ -24,16 +24,16 @@ We recommend using [Anaconda](https://www.anaconda.com/) or [Miniconda](https://
2424
### Step 0 – Clone the repository
2525

2626
```bash
27-
git clone https://github.com/OpenSportsLab/soccernetpro-ui.git
28-
cd soccernetpro-ui
27+
git clone https://github.com/OpenSportsLab/VideoAnnotationTool.git
28+
cd VideoAnnotationTool
2929
```
3030

3131

3232
### Step 1 – Create a new Conda environment
3333

3434
```bash
35-
conda create -n soccernetpro-ui python=3.9 -y
36-
conda activate soccernetpro-ui
35+
conda create -n VideoAnnotationTool python=3.9 -y
36+
conda activate VideoAnnotationTool
3737
```
3838

3939

@@ -63,14 +63,14 @@ This project provides **test datasets** for multiple tasks, including:
6363
- **Description (Video Captioning)**
6464
- **Dense Description (Dense Video Captioning)**
6565

66-
More details are available at: [`/test_data`](https://github.com/OpenSportsLab/soccernetpro-ui/tree/main/test_data)
66+
More details are available at: [`/test_data`](https://github.com/OpenSportsLab/VideoAnnotationTool/tree/main/test_data)
6767

6868
> ⚠️ **Important**
6969
> For all tasks, the corresponding **JSON annotation file must be placed in the same directory**
7070
> as the referenced data folders (e.g., `test/`, `germany_bundesliga/`, etc.).
7171
> Otherwise, the GUI may not load the data correctly due to relative path mismatches.
7272
73-
Some Hugging Face datasets (including SoccerNetPro datasets) are **restricted / gated**. Therefore you must:
73+
Some Hugging Face datasets (including OSL datasets) are **restricted / gated**. Therefore you must:
7474

7575
1. Have access to the dataset on Hugging Face
7676
2. Be authenticated locally using your Hugging Face account (`hf auth login`)
@@ -151,6 +151,7 @@ python test_data/download_osl_hf.py \
151151
**Data location (HuggingFace):**
152152
- [Localization Dataset (Soccer)](https://huggingface.co/datasets/OpenSportsLab/soccernetpro-localization-snas)
153153
- [Localization Dataset (Tennis)](https://huggingface.co/datasets/OpenSportsLab/soccernetpro-localization-tennis)
154+
- [Localization Dataset (gymnastics)](https://huggingface.co/datasets/OpenSportsLab/soccernetpro-localization-gymnastics)
154155

155156
Each folder (e.g., `england efl/`) contains video clips for localization testing.
156157

@@ -199,7 +200,7 @@ Test_Data/Description/XFoul/
199200
200201
---
201202
202-
## 🟧 Dense Description (Dense Video Captioning) – SoccerNetPro SNDVC
203+
## 🟧 Dense Description (Dense Video Captioning)
203204
204205
**Dataset (Hugging Face):**
205206
[Dense—Description Dataset](https://huggingface.co/datasets/OpenSportsLab/soccernetpro-densedescription-sndvc)
@@ -266,7 +267,7 @@ The commands below assume you run them **from the repository root**.
266267
cd annotation_tool
267268

268269
python -m PyInstaller --noconfirm --clean --windowed \
269-
--name "SoccerNetProAnalyzer" \
270+
--name "VideoAnnotationTool" \
270271
--add-data "style:style" \
271272
--add-data "ui:ui" \
272273
--add-data "controllers:controllers" \
@@ -275,7 +276,7 @@ python -m PyInstaller --noconfirm --clean --windowed \
275276

276277
Output:
277278

278-
* `annotation_tool/dist/SoccerNetProAnalyzer.app`
279+
* `annotation_tool/dist/VideoAnnotationTool.app`
279280

280281
---
281282

@@ -287,7 +288,7 @@ Output:
287288
cd annotation_tool
288289

289290
python -m PyInstaller --noconfirm --clean --windowed --onefile \
290-
--name "SoccerNetProAnalyzer" \
291+
--name "VideoAnnotationTool" \
291292
--add-data "style:style" \
292293
--add-data "ui:ui" \
293294
--add-data "controllers:controllers" \
@@ -296,7 +297,7 @@ python -m PyInstaller --noconfirm --clean --windowed --onefile \
296297

297298
Output:
298299

299-
* `annotation_tool/dist/SoccerNetProAnalyzer`
300+
* `annotation_tool/dist/VideoAnnotationTool`
300301

301302

302303
#### Windows (PowerShell)
@@ -307,7 +308,7 @@ On Windows, the `--add-data` separator is **`;`** (not `:`).
307308
cd annotation_tool
308309
309310
python -m PyInstaller --noconfirm --clean --windowed --onefile `
310-
--name "SoccerNetProAnalyzer" `
311+
--name "VideoAnnotationTool" `
311312
--add-data "style;style" `
312313
--add-data "ui;ui" `
313314
--add-data "controllers;controllers" `
@@ -316,7 +317,7 @@ python -m PyInstaller --noconfirm --clean --windowed --onefile `
316317

317318
Output:
318319

319-
* `annotation_tool\dist\SoccerNetProAnalyzer.exe`
320+
* `annotation_tool\dist\VideoAnnotationTool.exe`
320321

321322
---
322323

@@ -356,10 +357,10 @@ There is also a standalone build workflow that can be triggered manually:
356357

357358
## 📜 License
358359

359-
This Soccernet Pro project offers two licensing options to suit different needs:
360+
This Video Annotation Tool project offers two licensing options to suit different needs:
360361

361-
* **AGPL-3.0 License**: This open-source license is ideal for students, researchers, and the community. It supports open collaboration and sharing. See the [`LICENSE.txt`](https://github.com/OpenSportsLab/soccernetpro-ui/blob/main/LICENSE.txt) file for full details.
362-
* **Commercial License**: Designed for [`commercial use`](https://github.com/OpenSportsLab/soccernetpro-ui/blob/main/COMMERCIAL_LICENSE.md
362+
* **AGPL-3.0 License**: This open-source license is ideal for students, researchers, and the community. It supports open collaboration and sharing. See the [`LICENSE.txt`](https://github.com/OpenSportsLab/VideoAnnotationTool/blob/main/LICENSE.txt) file for full details.
363+
* **Commercial License**: Designed for [`commercial use`](https://github.com/OpenSportsLab/VideoAnnotationTool/blob/main/COMMERCIAL_LICENSE.md
363364
), this option allows you to integrate this software into proprietary products and services without the open-source obligations of GPL-3.0. If your use case involves commercial deployment, please contact the maintainers to obtain a commercial license.
364365

365366
**Contact:** OpenSportsLab / project maintainers.

0 commit comments

Comments
 (0)