Salesforce
/

xgen-mm-vid-phi3-mini-r-v1.5-128tokens-16frames

Image-Text-to-Text

Safetensors

English

xgenmm

custom_code

Model card Files Files and versions Community

michaelryoo commited on 17 days ago

Commit

cfabfd0

•

1 Parent(s): 0fdfc65

Update README.md

Browse files

Files changed (1) hide show

README.md +64 -169

README.md CHANGED Viewed

@@ -1,199 +1,94 @@
 ---
-library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+license: cc-by-nc-4.0
+language:
+- en
+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.
+In this initial release (12/2024), we are sharing the 128 token version trained to take 16-frame video inputs.
+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.py) for example code to use our model. It 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
+```