Update README.md

README.md

@@ -1,3 +1,153 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+datasets:
+- OpenGVLab/VideoChat2-IT
+- Lin-Chen/ShareGPT4V
+- liuhaotian/LLaVA-Instruct-150K
+language:
+- en
+metrics:
+- accuracy
+library_name: transformers
+pipeline_tag: visual-question-answering
+tags:
+- multimodal large language model
+- large video-language model
+---
+
+<p align="center">
+    <img src="https://cdn-uploads.huggingface.co/production/uploads/63913b120cf6b11c487ca31d/ROs4bHIp4zJ7g7vzgUycu.png" width="150" style="margin-bottom: 0.2;"/>
+<p>
+
+
+<h3 align="center"><a href="https://arxiv.org/abs/2406.07476">VideoLLaMA 2: Advancing Spatial-Temporal Modeling and Audio Understanding in Video-LLMs</a></h3>
+<h5 align="center"> If you like our project, please give us a star ⭐ on <a href="https://github.com/DAMO-NLP-SG/VideoLLaMA2">Github</a> for the latest update.  </h2>
+
+<p align="center"><video src="https://cdn-uploads.huggingface.co/production/uploads/63913b120cf6b11c487ca31d/Wj7GuqQ0CB9JRoPo6_GoH.webm" width="800"></p>
+
+## 📰 News
+* **[2024.06.12]**  Release model weights and the first version of the technical report of VideoLLaMA 2.
+* **[2024.06.03]**  Release training, evaluation, and serving codes of VideoLLaMA 2.
+
+
+## 🌎 Model Zoo
+| Model Name     | Type | Visual Encoder | Language Decoder | # Training Frames |
+|:-------------------|:--------------:|:----------------|:------------------|:----------------------:|
+| [VideoLLaMA2-7B-Base](https://huggingface.co/DAMO-NLP-SG/VideoLLaMA2-7B-Base)  | Base  | [clip-vit-large-patch14-336](https://huggingface.co/openai/clip-vit-large-patch14-336) | [Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2)  | 8 |
+| [VideoLLaMA2-7B](https://huggingface.co/DAMO-NLP-SG/VideoLLaMA2-7B)  | Chat | [clip-vit-large-patch14-336](https://huggingface.co/openai/clip-vit-large-patch14-336) | [Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2)  | 8 |
+| [VideoLLaMA2-7B-16F-Base](https://huggingface.co/DAMO-NLP-SG/VideoLLaMA2-7B-16F-Base)  | Base  | [clip-vit-large-patch14-336](https://huggingface.co/openai/clip-vit-large-patch14-336) | [Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2)  | 16 |
+| [VideoLLaMA2-7B-16F](https://huggingface.co/DAMO-NLP-SG/VideoLLaMA2-7B-16F) (This checkpoint)  | Chat | [clip-vit-large-patch14-336](https://huggingface.co/openai/clip-vit-large-patch14-336) | [Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2)  | 16 |
+
+
+
+## 🚀 Main Results
+
+### Multi-Choice Video QA & Video Captioning
+<p><img src="https://github.com/DAMO-NLP-SG/VideoLLaMA2/assets/18526640/9cc4a5ae-d850-4eef-bd51-83688b94698e" width="800" "/></p>
+
+
+###  Open-Ended Video QA
+<p><img src="https://github.com/DAMO-NLP-SG/VideoLLaMA2/assets/18526640/2ed7aa53-db56-4829-8375-85aefbc5120a" width="800" "/></p>
+
+
+
+
+## 🤖 Inference with VideoLLaMA2
+```python
+import torch
+import transformers
+
+import sys
+sys.path.append('./')
+from videollama2.conversation import conv_templates, SeparatorStyle
+from videollama2.constants import DEFAULT_MMODAL_TOKEN, MMODAL_TOKEN_INDEX
+from videollama2.mm_utils import get_model_name_from_path, tokenizer_MMODAL_token, KeywordsStoppingCriteria, process_video, process_image
+from videollama2.model.builder import load_pretrained_model
+
+
+def inference():
+    # Video Inference
+    paths = ['assets/cat_and_chicken.mp4']
+    questions = ['What animals are in the video, what are they doing, and how does the video feel?']
+    # Reply:
+    # The video features a kitten and a baby chick playing together. The kitten is seen laying on the floor while the baby chick hops around. The two animals interact playfully with each other, and the video has a cute and heartwarming feel to it.
+    modal_list = ['video']
+
+    # Video Inference
+    paths = ['assets/sora.mp4']
+    questions = ['Please describe this video.']
+    # Reply:
+    # The video features a series of colorful kites flying in the sky. The kites are first seen flying over trees, and then they are shown flying in the sky. The kites come in various shapes and colors, including red, green, blue, and yellow. The video captures the kites soaring gracefully through the air, with some kites flying higher than others. The sky is clear and blue, and the trees below are lush and green. The kites are the main focus of the video, and their vibrant colors and intricate designs are highlighted against the backdrop of the sky and trees. Overall, the video showcases the beauty and artistry of kite-flying, and it is a delight to watch the kites dance and glide through the air.
+    modal_list = ['video']
+
+    # Image Inference
+    paths = ['assets/sora.png']
+    questions = ['What is the woman wearing, what is she doing, and how does the image feel?']
+    # Reply:
+    # The woman in the image is wearing a black coat and sunglasses, and she is walking down a rain-soaked city street. The image feels vibrant and lively, with the bright city lights reflecting off the wet pavement, creating a visually appealing atmosphere. The woman's presence adds a sense of style and confidence to the scene, as she navigates the bustling urban environment.
+    modal_list = ['image']
+
+    # 1. Initialize the model.
+    model_path = 'DAMO-NLP-SG/VideoLLaMA2-7B-16F'
+    model_name = get_model_name_from_path(model_path)
+    tokenizer, model, processor, context_len = load_pretrained_model(model_path, None, model_name)
+    model = model.to('cuda:0')
+    conv_mode = 'llama_2'
+
+    # 2. Visual preprocess (load & transform image or video).
+    if modal_list[0] == 'video':
+        tensor = process_video(paths[0], processor, model.config.image_aspect_ratio).to(dtype=torch.float16, device='cuda', non_blocking=True)
+        default_mm_token = DEFAULT_MMODAL_TOKEN["VIDEO"]
+        modal_token_index = MMODAL_TOKEN_INDEX["VIDEO"]
+    else:
+        tensor = process_image(paths[0], processor, model.config.image_aspect_ratio)[0].to(dtype=torch.float16, device='cuda', non_blocking=True)
+        default_mm_token = DEFAULT_MMODAL_TOKEN["IMAGE"]
+        modal_token_index = MMODAL_TOKEN_INDEX["IMAGE"]
+    tensor = [tensor]
+
+    # 3. Text preprocess (tag process & generate prompt).
+    question = default_mm_token + "\n" + questions[0]
+    conv = conv_templates[conv_mode].copy()
+    conv.append_message(conv.roles[0], question)
+    conv.append_message(conv.roles[1], None)
+    prompt = conv.get_prompt()
+    input_ids = tokenizer_MMODAL_token(prompt, tokenizer, modal_token_index, return_tensors='pt').unsqueeze(0).to('cuda:0')
+
+    # 4. Generate a response according to visual signals and prompts. 
+    stop_str = conv.sep if conv.sep_style in [SeparatorStyle.SINGLE] else conv.sep2
+    # keywords = ["<s>", "</s>"]
+    keywords = [stop_str]
+    stopping_criteria = KeywordsStoppingCriteria(keywords, tokenizer, input_ids)
+
+    with torch.inference_mode():
+        output_ids = model.generate(
+            input_ids,
+            images_or_videos=tensor,
+            modal_list=modal_list,
+            do_sample=True,
+            temperature=0.2,
+            max_new_tokens=1024,
+            use_cache=True,
+            stopping_criteria=[stopping_criteria],
+        )
+
+    outputs = tokenizer.batch_decode(output_ids, skip_special_tokens=True)
+    print(outputs[0])
+
+
+if __name__ == "__main__":
+    inference()
+```
+
+
+## Citation
+If you find our project useful, hope you can star our repo and cite our paper as follows:
+```
+@article{damonlpsg2024videollama2,
+  author = {Cheng, Zesen and Leng, Sicong and Zhang, Hang and Xin, Yifei and Li, Xin and Chen, Guanzheng and Zhu, Yongxin and Zhang, Wenqi and Luo, Ziyang and Bing, Lidong},
+  title = {VideoLLaMA 2: Advancing Spatial-Temporal Modeling and Audio Understanding in Video-LLMs},
+  year = 2024,
+  journal = {arXiv preprint arXiv:2406.07476},
+  url = {https://arxiv.org/abs/2406.07476}
+}
+```