Update README.md

README.md

@@ -1,3 +1,83 @@
----
-license: mit
----
+---
+configs:
+- config_name: Live-CC-5M for Dataset Viewer
+  data_files:
+  - split: preview_first_100
+    path: live_cc_100_for_preview.json
+  - split: full_5m
+    path: live_cc_5m_for_preview.json
+license: apache-2.0
+task_categories:
+- video-text-to-text
+language:
+- en
+size_categories:
+- 1M<n<10M
+---
+
+# Dataset Card for LiveCC-WhisperX-528K
+
+## Dataset Description
+- **Curated by:** Joya Chen
+- **Language(s) (NLP):** English
+- **License:** Apache License 2.0
+
+## Uses
+This dataset is used for the training of the [LiveCC-7B-Base](https://huggingface.co/chenjoya/LiveCC-7B-Instruct) model. We only allow the use of this dataset for academic research and educational purposes. For OpenAI GPT-4o generated user prompts, we recommend users check the [OpenAI Usage Policy](https://openai.com/policies/usage-policies/).
+
+- **Project Page**: https://showlab.github.io/livecc/
+- **Paper**: https://arxiv.org/abs/xxxx.xxxxx
+- **Training Code**: https://www.github.com/showlab/livecc
+
+### Data Sources
+
+- **Live-CC-5M**: This repository includes
+  - Annotation JSONL (YouTube CC): https://huggingface.co/datasets/chenjoya/Live-CC-5M/blob/main/live_cc_5m_with_seeks.jsonl
+  
+  Due to 5M videos are too large, we are sorry that we cannot provide them. But,
+  - You can find all YouTube keys in the annotation JSONL
+  - We have released video files in SFT set: https://huggingface.co/datasets/chenjoya/Live-WhisperX-528K
+
+  This dataset contains 5,047,208 YouTube Video-CC instances, with YouTube categories:
+  ```
+  {'People & Blogs': 1130380, 'Howto & Style': 889359, 'Entertainment': 585838, 'Education': 453305, 'Sports': 449166, 'Autos & Vehicles': 410228, 'Science & Technology': 345308, 'Film & Animation': 197529, 'Travel & Events': 151357, 'Pets & Animals': 127535, 'Gaming': 117149, 'News & Politics': 83560, 'Nonprofits & Activism': 59140, 'Comedy': 47354}
+  ```
+  Each line of the JSONL file is organized in a common user/assistant conversation format with a special "text_stream" key. Example:
+  ```
+  [
+    {"role": "user", "content": [{"type": "video", "video": "video/youtube/-4dnPeRv1ns.mp4", "video_start": 16.8, "video_end": 158.8}, {"type": "text", "text": "", "previous": "", "title": "Airsoft G&G Combat Machine M4 Review"}]},
+    {"role": "assistant", "content": [{"type": "text_stream", "text_stream": [[16.8, 16.9, "all"], [16.9, 17.0, "right"], [17.0, 17.1, "you"], [17.1, 17.3, "guys"], [17.3, 17.4, "so"], [17.4, 17.5, "this"], ...]}]}
+  ]
+  ```
+  "title" denotes the YouTube title. "previous" denotes previous ASR content before "video_start". Each item in "text_stream" indicates start timestamp, end timestamp, and the word. During pre-training, we use "title" and "previous" as context. Please refer to our dataloader (https://github.com/showlab/livecc/data/lmm_dataset.py) to learn how to make it compatible with popular LMMs (e.g. QwenVL series).
+  
+  The last line of JSONL contains the file handle seek indices:
+  ```
+  [0, 3149, 7796, 10436, 18949, 22917, 41985, 65721, 73045, 76797, 82262, ...]
+  ```
+  This allows for easy streaming access using:
+  
+  ```
+  with open('live_whisperx_528k_with_seeks.jsonl') as f:
+    f.seek(seek_index)
+    datum = json.loads(f.readline())
+  ```
+
+### Data Pipeline
+
+Please refer to Section 3 of our [paper](https://arxiv.org/abs/xxxx.xxxxx). It has been fully open-sourced at: https://github.com/showlab/livecc/data/production/pretrain
+
+## Citation
+
+```bibtex
+@inproceedings{livecc,
+  author       = {Joya Chen and Ziyun Zeng and Yiqi Lin and Wei Li and Zejun Ma and Mike Zheng Shou},
+  title        = {LiveCC: Learning Video LLM with Streaming Speech Transcription at Scale},
+  booktitle    = {CVPR},
+  year         = {2025},
+}
+```
+
+## Dataset Card Contact
+
+[Joya Chen](https://chenjoya.github.io/)