Add pipeline tag, links and usage instructions

README.md

@@ -1,15 +1,48 @@
 ---
 license: apache-2.0
+pipeline_tag: video-classification
 ---
 
+# OmniShotCut: Holistic Relational Shot Boundary Detection with Shot-Query Transformer
 
-## OmniShotCut: Holistic Relational Shot Boundary Detection with Shot-Query Transformer
-
-OmniShotCut is a sensitive and more informative SoTA on the Shot Boundary Detection. \
-OmniShotCut can detect shot changes of the video in diverse sources (anime, vlog, game, shorts, sports, screen recording, etc.), and recognize Sudden Jump and Transitions (dissolve, fade, wipe, etc.) by proposing a Shot-Query-based Video Transformer.
-
+OmniShotCut is a sensitive and informative state-of-the-art (SoTA) model for Shot Boundary Detection (SBD). It can detect shot changes in videos from diverse sources (anime, vlog, game, shorts, sports, screen recording, etc.) and recognize Sudden Jumps and Transitions (dissolve, fade, wipe, etc.) by proposing a Shot-Query-based Video Transformer.
 
 [![Paper](https://img.shields.io/badge/arXiv-Paper-b31b1b?logo=arxiv&logoColor=white)](https://arxiv.org/abs/2604.24762)
 [![Website](https://img.shields.io/badge/Project-Website-pink?logo=googlechrome&logoColor=white)](https://uva-computer-vision-lab.github.io/OmniShotCut_website/)
+[![GitHub](https://img.shields.io/badge/GitHub-Code-blue?logo=github&logoColor=white)](https://github.com/UVA-Computer-Vision-Lab/OmniShotCut)
 <a href="https://huggingface.co/spaces/uva-cv-lab/OmniShotCut"><img src="https://img.shields.io/static/v1?label=%F0%9F%A4%97%20HF%20Space&message=Online+Demo&color=orange"></a>
 
+## Installation 🔧
+```shell
+conda create -n OmniShotCut python=3.10
+conda activate OmniShotCut
+pip install torch==2.5.1 torchvision==0.20.1 torchaudio==2.5.1 --index-url https://download.pytorch.org/whl/cu124
+pip install -r requirements.txt
+conda install ffmpeg
+```
+
+First, download the checkpoint:
+```shell
+mkdir checkpoints
+cd checkpoints
+wget https://huggingface.co/uva-cv-lab/OmniShotCut/resolve/main/OmniShotCut_ckpt.pth
+```
+
+## Inference ⚡
+We provide several modes for inference. The `clean_shot` mode is recommended for users who want the most direct results (valid shots without any transitions and sudden jumps).
+
+Execute the inference by running:
+```shell
+python test_code/inference.py --checkpoint_path checkpoints/OmniShotCut_ckpt.pth --input_video_path path/to/your/video.mp4 --mode clean_shot
+```
+The results will be visualized in a folder named `demo_video_results`, where vertical bars with the same color refer to the same shot.
+
+## Citation
+```bibtex
+@article{wang2026omnishotcut,
+  title={OmniShotCut: Holistic Relational Shot Boundary Detection with Shot-Query Transformer},
+  author={Wang, Boyang and Xu, Guangyi and Tang, Zhipeng and Zhang, Jiahui and Cheng, Zezhou},
+  journal={arXiv preprint arXiv:2604.24762},
+  year={2026}
+}
+```