Updating Model card

Updating model card to fit recommended standards. New model card is composed of the content available in the original model card for this repository.

README.md

@@ -2,58 +2,78 @@
 license: other
 license_name: intel-research-use-license
 license_link: LICENSE
+tags:
+- intel
+- gaudi
+- LLM
+results:
+  - task:
+      type: Large Language Model
+      name: Large Language Model
+    metrics:
+    - type: GQA
+      name: GQA
+      value: 60.6138
+    - type: MMVP
+      name: MMVP
+      value: 36
+    - type: Pope Acc
+      name: Pope Acc
+      value: 87.33
+    - type: Pope F1
+      name: Pope F1
+      value: 86.5
+    - type: MMVet
+      name: MMVet
+      value: 31.9725
+    - type: ScienceQA
+      name: ScienceQA
+      value: 72.9797
+    - type: llavaw (1)
+      name: llavaw
+      value: 56.9
+    - type: llavaw (2)
+      name: llavaw
+      value: 61.9
+    - type: llavaw (3)
+      name: llavaw
+      value: 73.6
+    - type: llavaw (4)
+      name: llavaw
+      value: 65.7
+    
+library_name: transformers
+pipeline_tag: image-text-to-text
 ---
 
-# LLaVA-Llama3 Model Card
+## Model Details:  LLaVA-llama-3-8B
 
-_This model card corresponds to the instruction tuned 8B version of the model with the CLIP-based vision encoder._
+`llava-llama-3-8b` is a large multimodal model (LMM) trained using the [LLaVA-v1.5 framework](https://arxiv.org/abs/2310.03744) with the 8-billion parameter [`meta-llama/Meta-Llama-3-8B-Instruct`](https://huggingface.co/meta-llama/Meta-Llama-3-8B) model as language backbone and the CLIP-based vision encoder.
 
+| Model Details | Description |
+| ----------- | ----------- | 
+| Authors | Intel: [Musashi Hinck*](https://huggingface.co/musashihinck), [Matthew L. Olson*](https://huggingface.co/matthewlyleolson),  [Vasudev Lal](https://huggingface.co/vasudevlal) | 
+| Date | May 2024 | 
+| Version | 1 | 
+| Type | Large multimodal model (LMM) | 
+| Paper or Other Resources | [Improved Baselines with Visual Instruction Tuning](https://arxiv.org/abs/2310.03744) | 
+| License | [Intel Research Use License](https://huggingface.co/Intel/llava-llama-3-8b/blob/main/LICENSE) | All usage code is licensed Apache 2.0
+| Questions or Comments | [Community Tab](https://huggingface.co/Intel/llava-llama-3-8b/discussions) and [Intel DevHub Discord](https://discord.gg/rv2Gp55UJQ)|
 
-## Overview
+This model card was created by [Eduardo Alvarez](https://huggingface.co/eduardo-alvarez) and the authors listed above.
 
-`llava-llama-3-8b` is a large multimodal model (LMM) trained using the [LLaVA-v1.5 framework](https://arxiv.org/abs/2310.03744) with the 8-billion parameter [`meta-llama/Meta-Llama-3-8B-Instruct`](https://huggingface.co/meta-llama/Meta-Llama-3-8B) model as language backbone.
+## Intended Use
 
-## Uses
+| Intended Use | Description |
+| ----------- | ----------- | 
+| Primary intended uses | The model has been finetuned for multimodal benchmark evaluations, but can also be used as a multimodal chatbot. | 
+| Primary intended users | Anyone using or evaluating multimodal models. | 
+| Out-of-scope uses | This model is not intended for uses that require high levels of factuality, high stakes situations, mental health or medical applications, generating misinformation or disinformation, impersonating others, facilitating or inciting harassment or violence, any use that could lead to the violation of a human right under the UN Declaration of Human Rights. |
 
-The model has been finetuned for multimodal benchmark evaluations, but can also be used as a multimodal chatbot.
 
-## Bias, Risks, and Limitations
+### How to use
 
-This model has not been assessed for harm or biases, and should not be used for sensitive applications where it may cause harm.
-
-## Training Details
-
-The `llava-llama-3-8b` model was trained on a 4 node cluster with a total of 32 Gaudi 2 accelerators.
-
-### Training Data
-
-The model was trained using the LLaVA-v1.5 data mixture.
-
-This is listed as follows:
-
-- 558K filtered image-text pairs from LAION/CC/SBU, captioned by BLIP.
-- 158K GPT-generated multimodal instruction-following data.
-- 450K academic-task-oriented VQA data mixture.
-- 40K ShareGPT data.
-
-## Evaluation
-
-| Model    | Metrics          |
-|----------|------------------|
-| ScienceQA| 72.9797          |
-| MMVet    | 31.9725          |
-| llavaw   | 56.9/61.9/73.6/65.7 |
-| Pope Acc | 87.33, F1 86.5   |
-| GQA      | 60.6138          |
-| MMVP     | 36               |
-
-## License
-The weights are released under the Intel Research Use License Agreement (see LICENSE file)  
-All usage code is licensed Apache 2.0
-
-## Usage
-
-Please note, we only provide the trained weights difference and do not provide a copy of the base [`meta-llama/Meta-Llama-3-8B-Instruct`](https://huggingface.co/meta-llama/Meta-Llama-3-8B) model.  Any use of these weights requires a separate download of the base model.
+Please note, we only provide the trained weights difference and do not provide a copy of the base meta-llama/Meta-Llama-3-8B-Instruct model. Any use of these weights requires a separate download of the base model.
 
 ```python
 # Copyright 2024 Intel Corporation
@@ -135,4 +155,36 @@ inputs = processor(text=prompt, images=image, return_tensors="pt").to(device)
 generate_ids = model.generate(**inputs, max_length=30)
 output = processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
 print(output)
-```
+```
+
+## Factors
+
+| Factors | Description | 
+| ----------- | ----------- | 
+| Environment | Trained on a 4 node cluster with a total of 32 Gaudi 2 accelerators |
+| Card Prompts | Model training and deployment on alternate hardware and software will change model performance |
+
+## Training Data
+
+The model was trained using the LLaVA-v1.5 data mixture. This is listed as follows:
+
+- 558K filtered image-text pairs from LAION/CC/SBU, captioned by BLIP.
+- 158K GPT-generated multimodal instruction-following data.
+- 450K academic-task-oriented VQA data mixture.
+- 40K ShareGPT data.
+
+## Ethical Considerations
+
+Intel is committed to respecting human rights and avoiding causing or contributing to adverse impacts on human rights. See [Intel’s Global Human Rights Principles](https://www.intel.com/content/dam/www/central-libraries/us/en/documents/policy-human-rights.pdf). Intel’s products and software are intended only to be used in applications that do not cause or contribute to adverse impacts on human rights.
+
+| Ethical Considerations | Description | 
+| ----------- | ----------- | 
+| Data | The model was trained using the LLaVA-v1.5 data mixture as described above. |
+| Human life | The model is not intended to inform decisions central to human life or flourishing. | 
+| Mitigations | No additional risk mitigation strategies were considered during model development. |
+| Risks and harms | This model has not been assessed for harm or biases, and should not be used for sensitive applications where it may cause harm. |
+| Use cases | - | 
+
+## Caveats and Recommendations
+
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. This model has not been assessed for harm or biases, and should not be used for sensitive applications where it may cause harm.