Create README.md

README.md

@@ -0,0 +1,49 @@
+---
+# For reference on model card metadata, see the spec: https://github.com/huggingface/hub-docs/blob/main/modelcard.md?plain=1
+# Doc / guide: https://huggingface.co/docs/hub/model-cards
+{}
+---
+
+# LLaVA-Next Interleave Model Card
+
+## Model Details
+
+Model type: LLaVA-Next Interleave is an open-source chatbot trained by fine-tuning LLM on multimodal instruction-following data. It is an auto-regressive language model, based on the transformer architecture. 
+
+Base LLM: Qwen/Qwen1.5-7B-Chat
+
+### Model Description
+
+**Repository:** https://github.com/LLaVA-VL/LLaVA-NeXT
+
+**Primary intended uses:** The primary use of LLaVA-Next Interleave is research on large multimodal models and chatbots. This is only for research exploration, and prohibited for commercial usage.
+
+**Primary intended users:** The primary intended users of the model are researchers and hobbyists in computer vision, natural language processing, machine learning, and artificial intelligence.
+
+### License Notices
+  
+This project utilizes certain datasets and checkpoints that are subject to their respective original licenses. Users must comply with all terms and conditions of these original licenses, including but not limited to the OpenAI Terms of Use for the dataset and the specific licenses for base language models for checkpoints trained using the dataset (e.g. Llama-1/2 community license for LLaMA-2 and Vicuna-v1.5, [Tongyi Qianwen LICENSE AGREEMENT](https://github.com/QwenLM/Qwen/blob/main/Tongyi%20Qianwen%20LICENSE%20AGREEMENT) and [META LLAMA 3 COMMUNITY LICENSE AGREEMENT](https://llama.meta.com/llama3/license/)). This project does not impose any additional constraints beyond those stipulated in the original licenses. Furthermore, users are reminded to ensure that their use of the dataset and checkpoints is in compliance with all applicable laws and regulations.
+
+## How to Get Started with the Model
+
+Use the code below to get started with the model.
+
+```bash
+git clone https://github.com/LLaVA-VL/LLaVA-NeXT
+# install llava-next
+...
+# download the ckpt
+...
+bash playground/demo/interleave_demo.py --model_path path/to/ckpt
+```
+
+
+
+## Evaluation
+
+Use the code below to evaluate the model.
+
+Please first edit /path/to/ckpt to the path of checkpoint, /path/to/images to the path of "interleave_data" in scripts/interleave/eval_all.sh and then run
+```bash
+bash scripts/interleave/eval_all.sh
+```