deepvk
/

llava-saiga-8b

@@ -1,199 +1,109 @@
 ---
 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]

 ---
 library_name: transformers
+license: apache-2.0
+datasets:
+- deepvk/LLaVA-Instruct-ru
+- Lin-Chen/ShareGPT4V
+- deepvk/GQA-ru
+language:
+- ru
+- en
+base_model: IlyaGusev/saiga_llama3_8b
+pipeline_tag: image-text-to-text
 ---
+# LLaVA-Saiga-8b
+LLaVA-Saiga-8b is a Vision-Language Model (VLM) based on [`IlyaGusev/saiga_llama3_8b`](https://huggingface.co/IlyaGusev/saiga_llama3_8b) model
+and trained in original LLaVA setup. This model is primarily adapted to work with Russian, but still capable to work with English.
+## Usage
+Model usage is simple via `transformers` API
+```python
+import requests
+from PIL import Image
+from transformers import AutoProcessor, AutoTokenizer, LlavaForConditionalGeneration
+model_name = "deepvk/llava-saiga-8b"
+model = LlavaForConditionalGeneration.from_pretrained(model_name)
+processor = AutoProcessor.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+url = "https://www.ilankelman.org/stopsigns/australia.jpg"
+img = Image.open(requests.get(url, stream=True).raw)
+messages = [
+    {"role": "user", "content": "<image>\nОпиши картинку несколькими словами."}
+]
+text = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+inputs = processor(images=[img], text=text, return_tensors="pt")
+generate_ids = model.generate(**inputs, max_new_tokens=30)
+answer = tokenizer.decode(generate_ids[0, inputs.input_ids.shape[1]:], skip_special_tokens=True)
+print(answer)
+```
+Use the `<image>` tag to point to an image in the text and follow the chat template for a multi-turn conversation.
+The model is capable of chatting without any images or working with multiple images in a conversation, but this behavior has not been tested.
+The model format allows it to be directly used in popular frameworks,
+e.g. you can test the model using [lmms-eval](https://github.com/EvolvingLMMs-Lab/lmms-eval), see Results section for details.
+## Train
+To train this model, we follow the original LLaVA pipeline and reuse [`haotian-liu/LLaVA`](https://github.com/haotian-liu/LLaVA) framework.
+The model was trained in two stages:
+1. The adapter was trained using pre-training data from [`ShareGPT4V`](https://github.com/InternLM/InternLM-XComposer/tree/main/projects/ShareGPT4V).
+2. Instruction tuning included training the LLM and the adapter, for this we use:
+    * [`deepvk/LLaVA-Instruct-ru`](https://huggingface.co/datasets/deepvk/LLaVA-Instruct-ru) - our new dataset of VLM instructions in Russian
+    * [`deepvk/GQA-ru`](https://huggingface.co/datasets/deepvk/GQA-ru) - the training part of the popular GQA test, translated into Russian, we used the post-prompt "Ответь одним словом. ".
+    * We also used instruction data from ShareGPT4V.
+The entire training process took 3-4 days on 8 x A100 80GB.
+## Results
+The model's performance was evaluated using [`lmms-eval`](https://github.com/EvolvingLMMs-Lab/lmms-eval/tree/main) framework
+```bash
+accelerate launch -m lmms_eval --model llava_hf --model_args pretrained="deepvk/llava-saiga-8b" \
+  --tasks gqa-ru,mmbench_ru_dev,gqa,mmbench_en_dev --batch_size 1 \
+  --log_samples --log_samples_suffix llava-saiga-8b --output_path ./logs/
+```
+| Model                                                                                           | GQA       | GQA-ru    | MMBench   | MMBench-ru |
+| ----------------------------------------------------------------------------------------------- |:---------:|:---------:|:---------:|:----------:|
+| [`deepvk/llava-gemma-2b-lora`](https://huggingface.co/deepvk/llava-gemma-2b-lora)               | 56.39     | 46.37     | 51.72     | 40.19      |
+| [`Intel/llava-gemma-2b`](https://huggingface.co/Intel/llava-gemma-2b)                           | 59.80     | 0.20      | 39.40     | 28.30      |
+| `deepvk/llava-saiga-8b` [this model]                                                            | 62.00     | **51.44** | 64.26     | **56.65**  |
+| [`llava-hf/llava-1.5-7b-hf`](https://huggingface.co/llava-hf/llava-1.5-7b-hf)                   | 61.31     | 28.39     | 62.97     | 52.25      |
+| [`llava-hf/llava-v1.6-mistral-7b-hf`](https://huggingface.co/llava-hf/llava-v1.6-mistral-7b-hf) | **64.65** | 6.65      | **67.70** | 48.80      |
+*Note*: for MMBench we didn't use OpenAI API for finding quantifier in generated string. Therefore, the score is similar to Exact Match as in GQA benchmark.
+## Citation
+```
+@misc{liu2023llava,
+  title={Visual Instruction Tuning},
+  author={Liu, Haotian and Li, Chunyuan and Wu, Qingyang and Lee, Yong Jae},
+  publisher={NeurIPS},
+  year={2023},
+}
+```
+```
+@misc{deepvk2024llava-saiga-8b,
+	title={LLaVA-Saiga-8b},
+	author={Belopolskih, Daniil and Spirin, Egor},
+	url={https://huggingface.co/deepvk/llava-saiga-8b},
+	publisher={Hugging Face}
+	year={2024},
+}
+```