Update README.md

README.md

@@ -1,3 +1,96 @@
----
-license: cc-by-nc-4.0
----
+---
+language:
+- en
+license: cc-by-nc-4.0
+pipeline_tag: image-text-to-text
+---
+
+# Model description
+`xGen-MM-Vid (BLIP-3-Video)` is an efficient compact vision-language model (VLM) with an explicit temporal encoder, specifically designed to understand videos. It is developed by Salesforce AI Research. Incorporation of a learanable temporal encoder modules within the original (image-based) BLIP-3 architecture is its key aspect.
+
+Here, we are sharing the 32 token version trained to take 8-frame video inputs. In principle, it is able to take any number of frames, but it was trained with 8-frame videos.
+
+The 128 token version of the same model could be found at: [BLIP-3-Video 128 token model](https://huggingface.co/Salesforce/xgen-mm-vid-phi3-mini-r-v1.5-128tokens-8frames/).
+
+For more details, check out our [tech report](https://arxiv.org/pdf/2410.16267). More detailed explanation could also be found in the [blog article](https://www.salesforceairesearch.com/opensource/xGen-MM-Vid/index.html).
+
+
+# Results
+
+### Tokens vs. accuracy
+
+<p>
+  <figure style="max-width: 480px; margin: 0 auto;">
+    <a href="https://www.salesforceairesearch.com/opensource/xGen-MM-Vid/figures/tokens-vs-accuracy.png"><img src="https://www.salesforceairesearch.com/opensource/xGen-MM-Vid/figures/tokens-vs-accuracy.png"></a>
+  </figure>
+</p>
+The above figure shows the number of visual tokens vs. accuracy trade-off of various video models including xGen-MM-Vid (BLIP-3-Video) on the MSVD-QA dataset.
+
+
+### Examples
+
+<p>
+  <figure style="max-width: 480px; margin: 0 auto;">
+  <video style="max-width:100%;width:480px" autoplay muted controls loop>
+      <source src="https://www.salesforceairesearch.com/opensource/xGen-MM-Vid/figures/xgen-mm-vid1.mp4" type="video/mp4">
+  Your browser does not support the video tag.
+  </video>
+  </figure>
+</p>
+
+<p>
+  <figure style="max-width: 480px; margin: 0 auto;">
+  <video style="max-width:100%;width:480px" autoplay muted controls loop>
+      <source src="https://www.salesforceairesearch.com/opensource/xGen-MM-Vid/figures/xgen-mm-vid2.mp4" type="video/mp4">
+  Your browser does not support the video tag.
+  </video>
+  </figure>
+</p>
+
+
+# How to use
+
+Please check out our [inference script](xgen-mm-vid-inference-script_hf.py) as an example to use our model. This codebase is based on the [xGen-MM](https://huggingface.co/Salesforce/xgen-mm-phi3-mini-instruct-interleave-r-v1.5).
+
+
+
+# Bias, Risks, Limitations, and Ethical Considerations
+The main data sources are from the internet, including webpages, video stock sites, and curated datasets released by the research community. 
+The model may be subject to bias from the original data source, as well as bias from LLMs and commercial APIs. 
+We strongly recommend users assess safety and fairness before applying to downstream applications. 
+
+
+
+# License
+
+Our code and weights are released under the [CC by-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/deed.en) license.
+
+
+# Code acknowledgment
+Our code/model is built on top of [xGen-MM](https://huggingface.co/Salesforce/xgen-mm-phi3-mini-instruct-interleave-r-v1.5).
+
+
+# Citation
+```
+@misc{blip3video-xgenmmvid,
+  author          = {Michael S. Ryoo and Honglu Zhou and Shrikant Kendre and Can Qin and Le Xue and Manli Shu and Silvio Savarese and Ran Xu and Caiming Xiong and Juan Carlos Niebles},
+  title           = {xGen-MM-Vid (BLIP-3-Video): You Only Need 32 Tokens to Represent a Video Even in VLMs}, 
+  year            = {2024},
+  eprint          = {2410.16267},
+  archivePrefix   = {arXiv},
+  primaryClass    = {cs.CV},
+  url             = {https://arxiv.org/abs/2410.16267}, 
+}
+```
+
+# Troubleshoot
+
+1. If you missed any packages, please consider the following
+
+```
+pip install torch==2.2.1 torchvision==0.17.1 torchaudio==2.2.1 --index-url https://download.pytorch.org/whl/cu121
+pip install open_clip_torch==2.24.0
+pip install einops
+pip install einops-exts
+pip install transformers==4.41.1
+```