Skip to content

Commit d18daac

Browse files
SilvioGiancolaSilvioGiancola
committed
Deployed 4c64dbb with MkDocs version: 1.6.1
1 parent 0137f47 commit d18daac

7 files changed

Lines changed: 163 additions & 32 deletions

File tree

‎batch_tools/index.html‎

Lines changed: 79 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@
6565
<label class="md-overlay" for="__drawer"></label>
6666
<div data-md-component="skip">
6767

68+
69+
<a href="#batch-tools" class="md-skip">
70+
Skip to content
71+
</a>
72+
6873
</div>
6974
<div data-md-component="announce">
7075

@@ -693,6 +698,21 @@
693698
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
694699

695700

701+
702+
703+
704+
<label class="md-nav__link md-nav__link--active" for="__toc">
705+
706+
707+
708+
<span class="md-ellipsis">
709+
Batch Tools
710+
711+
</span>
712+
713+
714+
<span class="md-nav__icon md-icon"></span>
715+
</label>
696716

697717
<a href="./" class="md-nav__link md-nav__link--active">
698718

@@ -706,6 +726,49 @@
706726

707727
</a>
708728

729+
730+
731+
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
732+
733+
734+
735+
736+
737+
738+
<label class="md-nav__title" for="__toc">
739+
<span class="md-nav__icon md-icon"></span>
740+
Table of contents
741+
</label>
742+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
743+
744+
<li class="md-nav__item">
745+
<a href="#dataset-downloader" class="md-nav__link">
746+
<span class="md-ellipsis">
747+
Dataset Downloader
748+
</span>
749+
</a>
750+
751+
<nav class="md-nav" aria-label="Dataset Downloader">
752+
<ul class="md-nav__list">
753+
754+
<li class="md-nav__item">
755+
<a href="#how-to-use" class="md-nav__link">
756+
<span class="md-ellipsis">
757+
How to Use
758+
</span>
759+
</a>
760+
761+
</li>
762+
763+
</ul>
764+
</nav>
765+
766+
</li>
767+
768+
</ul>
769+
770+
</nav>
771+
709772
</li>
710773

711774

@@ -852,9 +915,22 @@
852915

853916

854917

855-
<h1>Batch Tools</h1>
856-
857-
918+
<h1 id="batch-tools">Batch Tools<a class="headerlink" href="#batch-tools" title="Permanent link">&para;</a></h1>
919+
<h2 id="dataset-downloader">Dataset Downloader<a class="headerlink" href="#dataset-downloader" title="Permanent link">&para;</a></h2>
920+
<p>The Dataset Downloader tool lets you easily fetch sports video datasets from online sources (such as Hugging Face) directly to your computer for annotation.</p>
921+
<h3 id="how-to-use">How to Use<a class="headerlink" href="#how-to-use" title="Permanent link">&para;</a></h3>
922+
<ol>
923+
<li>Open the Dataset Downloader from the menu or use the shortcut <strong>Ctrl+D</strong>.</li>
924+
<li>Enter the URL of the dataset you want to download. For example:</li>
925+
<li><code>https://huggingface.co/datasets/OpenSportsLab/SoccerNet-ActionSpotting-Videos/blob/main/224p/test/annotations.json</code> for the test split of the SoccerNetv2 dataset.</li>
926+
<li>Choose the output directory where the dataset should be saved. For example:</li>
927+
<li><code>/Users/&lt;username&gt;/Documents/SoccerNet/</code></li>
928+
<li>Click the download button to start.</li>
929+
<li><strong>Dry Run:</strong> By default, the tool performs a dry run, listing the files that would be downloaded and the total storage required. Uncheck the dry run option to actually download the files.</li>
930+
<li>If you cancel the download, the current file will finish downloading before the process stops.</li>
931+
</ol>
932+
<p><strong>Note:</strong> To download from Hugging Face, you need an API key. Create one at <a href="https://huggingface.co/settings/tokens/new?tokenType=read">https://huggingface.co/settings/tokens/new?tokenType=read</a>. The key should look like <code>hf_xxxxx</code>.</p>
933+
<p>This tool helps you quickly set up new annotation projects by fetching datasets in the correct format, so you can start annotating right away.</p>
858934

859935

860936

‎gui_overview/index.html‎

Lines changed: 51 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -573,9 +573,27 @@
573573
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
574574

575575
<li class="md-nav__item">
576-
<a href="#key-interface-elements" class="md-nav__link">
576+
<a href="#left-panel-video-management" class="md-nav__link">
577577
<span class="md-ellipsis">
578-
Key Interface Elements
578+
Left Panel: Video Management
579+
</span>
580+
</a>
581+
582+
</li>
583+
584+
<li class="md-nav__item">
585+
<a href="#center-panel-video-player-controls" class="md-nav__link">
586+
<span class="md-ellipsis">
587+
Center Panel: Video Player &amp; Controls
588+
</span>
589+
</a>
590+
591+
</li>
592+
593+
<li class="md-nav__item">
594+
<a href="#right-panel-annotation-management" class="md-nav__link">
595+
<span class="md-ellipsis">
596+
Right Panel: Annotation Management
579597
</span>
580598
</a>
581599

@@ -909,17 +927,40 @@ <h1 id="gui-overview">GUI Overview<a class="headerlink" href="#gui-overview" tit
909927
<p>Refer to the screenshots below for a visual guide.</p>
910928
<p>The OSL Annotation Tool is organized in three main panels:</p>
911929
<p><img alt="GUI Layout" src="../assets/screenshot_layout.png" /></p>
930+
<h2 id="left-panel-video-management">Left Panel: Video Management<a class="headerlink" href="#left-panel-video-management" title="Permanent link">&para;</a></h2>
931+
<ul>
932+
<li><strong>Video List:</strong> Displays all loaded videos or games. Each entry shows the filename and the number of annotated events.</li>
933+
<li><strong>Add Video:</strong> Use the button to add new video files to your project.</li>
934+
<li><strong>Remove Video:</strong> Remove the selected video from the list and the project.</li>
935+
<li><strong>Selection:</strong> Clicking a video loads it into the player and displays its annotations in the right panel.</li>
936+
<li><strong>Load/Save Buttons:</strong> Quickly load or save your annotation project (OSL JSON format).</li>
937+
</ul>
938+
<h2 id="center-panel-video-player-controls">Center Panel: Video Player &amp; Controls<a class="headerlink" href="#center-panel-video-player-controls" title="Permanent link">&para;</a></h2>
912939
<ul>
913-
<li><strong>Left Panel:</strong> List of games or loaded videos</li>
914-
<li><strong>Center Panel:</strong> Video player with playback controls, timeline, and annotation tools</li>
915-
<li><strong>Right Panel:</strong> List of annotations (timestamp, label), with options to add, edit, or delete</li>
940+
<li><strong>Video Display:</strong> Shows the currently selected video. You can play, pause, and seek through the video.</li>
941+
<li><strong>Playback Controls:</strong></li>
942+
<li>Play/Pause, step forward/backward by frame or by time (1s, 5s)</li>
943+
<li>Change playback speed (1x, 2x, 4x, 8x, and slower speeds)</li>
944+
<li>Timeline slider for quick navigation</li>
945+
<li><strong>Status Bar:</strong> Shows the current time, total duration, and status messages.</li>
916946
</ul>
917-
<h3 id="key-interface-elements">Key Interface Elements<a class="headerlink" href="#key-interface-elements" title="Permanent link">&para;</a></h3>
947+
<h2 id="right-panel-annotation-management">Right Panel: Annotation Management<a class="headerlink" href="#right-panel-annotation-management" title="Permanent link">&para;</a></h2>
918948
<ul>
919-
<li><strong>Toolbar:</strong> Quick access to open, save, add annotation, and playback controls</li>
920-
<li><strong>Timeline:</strong> Visualizes video progress and annotation points</li>
921-
<li><strong>Annotation List:</strong> See, edit, or delete all actions for the loaded video</li>
922-
<li><strong>Status Bar:</strong> Messages and progress information</li>
949+
<li><strong>Annotation List:</strong> Shows all annotations for the selected video, including timestamp and label.</li>
950+
<li><strong>Add Annotation:</strong> </li>
951+
<li>Add a new annotation at the current video time.</li>
952+
<li><strong>Remove Annotation:</strong> </li>
953+
<li>Remove the currently selected annotation.</li>
954+
<li><strong>Edit Annotation:</strong></li>
955+
<li>Select an annotation to edit its label or timestamp</li>
956+
<li>Use "Set to Current Video Time" to update the annotation time</li>
957+
<li><strong>Label Management:</strong></li>
958+
<li>Add new labels or remove existing ones</li>
959+
<li>Assign labels to annotations</li>
960+
<li><strong>Metadata:</strong></li>
961+
<li>View or edit additional metadata for each annotation (if supported)</li>
962+
<li><strong>Navigation:</strong></li>
963+
<li>Quickly jump to previous or next annotation using navigation buttons</li>
923964
</ul>
924965
<p>For details on annotating, see <a href="../annotating/">Annotating Actions</a>.</p>
925966

‎index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -935,7 +935,7 @@ <h2 id="quick-links">Quick links<a class="headerlink" href="#quick-links" title=
935935
</ul>
936936
<hr />
937937
<h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">&para;</a></h2>
938-
<p>This project is licensed under the MIT License.<br />
938+
<p>This project is licensed under the GNU General Public License v3.0 (GPL-3.0).
939939
See <a href="https://github.com/OpenSportsLab/DatasetAnnotationTool">GitHub repository</a> for details.</p>
940940

941941

‎installation/index.html‎

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -496,15 +496,6 @@
496496
</span>
497497
</a>
498498

499-
</li>
500-
501-
<li class="md-nav__item">
502-
<a href="#troubleshooting" class="md-nav__link">
503-
<span class="md-ellipsis">
504-
Troubleshooting
505-
</span>
506-
</a>
507-
508499
</li>
509500

510501
</ul>
@@ -911,9 +902,12 @@
911902

912903

913904
<h1 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h1>
905+
<p><strong>Quick option:</strong></p>
906+
<p>Pre-built binaries for Windows, macOS, and Linux are available on the <a href="https://github.com/OpenSportsLab/DatasetAnnotationTool/releases">GitHub Releases page</a>. Download the latest release for your platform and run the executable—no installation required.</p>
907+
<hr />
914908
<h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">&para;</a></h2>
915909
<ul>
916-
<li>Python 3.8 or later</li>
910+
<li>Python 3.9 or later</li>
917911
<li>PyQt6</li>
918912
<li>Other dependencies (see <code>requirements.txt</code>)</li>
919913
</ul>
@@ -926,20 +920,32 @@ <h2 id="steps">Steps<a class="headerlink" href="#steps" title="Permanent link">&
926920
cd DatasetAnnotationTool</code></p>
927921
</li>
928922
<li>
929-
<p><strong>(Optional) Create a virtual environment:</strong>
923+
<p><strong>(Recommended) Create a Conda environment:</strong>
930924
<code>bash
931-
python -m venv osl-visualizer
932-
source osl-visualizer/bin/activate</code></p>
925+
conda create -n osl-visualizer python=3.9 -y
926+
conda activate osl-visualizer</code></p>
933927
</li>
934928
<li>
935929
<p><strong>Install dependencies:</strong>
936-
<code>bash
937-
pip install -r requirements.txt</code></p>
930+
The main dependencies are:</p>
931+
<ul>
932+
<li>pyqt6</li>
933+
<li>opencv-python (optional, for video rendering/computer vision)</li>
934+
<li>See <code>requirements.txt</code> for the full list</li>
935+
</ul>
936+
<p>Install with pip:
937+
```bash
938+
pip install pyqt6</p>
939+
<h1 id="optional-for-video-renderingcomputer-vision">Optional, for video rendering/computer vision:<a class="headerlink" href="#optional-for-video-renderingcomputer-vision" title="Permanent link">&para;</a></h1>
940+
<p>pip install opencv-python</p>
941+
<h1 id="or-install-all-dependencies">Or install all dependencies:<a class="headerlink" href="#or-install-all-dependencies" title="Permanent link">&para;</a></h1>
942+
<p>pip install -r requirements.txt
943+
```</p>
938944
</li>
939945
<li>
940946
<p><strong>Run the tool:</strong>
941947
<code>bash
942-
python -m osl_visualizer.main</code></p>
948+
python osl_visualizer/main.py</code></p>
943949
</li>
944950
</ol>
945951
<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h2>

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎shortcuts/index.html‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -866,11 +866,19 @@ <h1 id="keyboard-shortcuts">Keyboard Shortcuts<a class="headerlink" href="#keybo
866866
<li><strong>Ctrl+O</strong>: Open/Load annotation file</li>
867867
<li><strong>Ctrl+S</strong>: Save annotation file</li>
868868
<li><strong>Ctrl+Shift+S</strong>: Save As</li>
869+
<li><strong>Ctrl+E</strong>: Open Settings</li>
870+
<li><strong>Ctrl+D</strong>: Open Dataset Downloader</li>
869871
<li><strong>Space</strong>: Play/Pause video</li>
872+
<li><strong>Left Arrow</strong>: Step backward by one frame</li>
873+
<li><strong>Right Arrow</strong>: Step forward by one frame</li>
874+
<li><strong>Ctrl+Left Arrow</strong>: Step backward by 1 second</li>
875+
<li><strong>Ctrl+Right Arrow</strong>: Step forward by 1 second</li>
876+
<li><strong>Ctrl+Shift+Left Arrow</strong>: Step backward by 5 seconds</li>
877+
<li><strong>Ctrl+Shift+Right Arrow</strong>: Step forward by 5 seconds</li>
870878
<li><strong>A</strong>: Add annotation at current time</li>
871879
<li><strong>S</strong>: Set annotation time to video</li>
872-
<li><strong>Arrow keys</strong>: Step through video/annotations</li>
873880
</ul>
881+
<p>These shortcuts help you quickly control video playback, annotation, and access key features in the application.</p>
874882

875883

876884

‎sitemap.xml.gz‎

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)