Add README

README.md

@@ -0,0 +1,183 @@
+---
+license: cc-by-nc-4.0
+language:
+- en
+pipeline_tag: image-text-to-text
+tags:
+- nvidia
+- NVLM
+- pytorch
+- multimodal
+- conversational
+library_name: transformers
+---
+
+<p align="center">
+  <img src="nvlm-logo-light.png" alt="Image Description" width="300" >
+</p>
+
+
+# Model Overview
+
+## Description
+This family of models performs vision-language and text-only tasks including optical character recognition, multimodal reasoning, localization, common sense reasoning, world knowledge utilization, and coding.
+
+## License/Terms of Use
+[Creative Commons Attribution: Non-Commercial 4.0 International](https://spdx.org/licenses/CC-BY-NC-4.0) <br>
+
+# Model Details
+
+Today (September 17th, 2024), we introduce [NVLM 1.0](https://arxiv.org/abs/2409.11402), a family of frontier-class multimodal large language models (LLMs) that achieve state-of-the-art results on vision-language tasks, rivaling the leading proprietary models (e.g., GPT-4o) and open-access models (e.g., Llama 3-V 405B and InternVL 2). Remarkably, NVLM 1.0 shows improved text-only performance over its LLM backbone after multimodal training. 
+
+In this repo, we are open-sourcing NVLM-1.0-D-72B-mcore (decoder-only architecture), the decoder-only model weights for the community. The model is trained through [Megatron-Core](https://github.com/NVIDIA/Megatron-LM/tree/main/examples/multimodal/nvlm).
+
+
+
+## Reference(s)
+[Paper](https://arxiv.org/abs/2409.11402) &ensp; [Inference Code (HF)](https://huggingface.co/nvidia/NVLM-D-72B/tree/main) &ensp; [Training Code](https://github.com/NVIDIA/Megatron-LM/tree/main/examples/multimodal/nvlm) &ensp; [Website](https://research.nvidia.com/labs/adlr/NVLM-1/) 
+
+## Benchmark Results
+We train our model with [Megatron-Core](https://github.com/NVIDIA/Megatron-LM/tree/main/examples/multimodal/nvlm) and adapt the codebase to Huggingface for model hosting, reproducibility, and inference.
+We observe numerical differences between the Megatron and Huggingface codebases, which are within the expected range of variation. 
+We provide the results from both the Huggingface codebase and the Megatron codebase for reproducibility and comparison with other models.
+
+Results (as of September 17th, 2024) in the multimodal benchmarks are as follows:
+
+### Vision-language Benchmarks 
+
+| Benchmark                    | MMMU (val / test) | MathVista | OCRBench | AI2D | ChartQA | DocVQA | TextVQA | RealWorldQA | VQAv2 |
+|------------------------------|-------------------|-----------|----------|------|---------|--------|---------|-------------|-------|
+| NVLM-D 1.0 72B (Megatron-Core) | 59.9 / 54.1       | 67.4      | 851      | 94.4 | 86.9    | 92.1   | 81.2    | 66.8        | 85.4  |
+| Llama 3.2 90B                | 60.3 / -          | 57.3      | -        | 92.3 | 85.5    | 90.1   | -       | -           | 78.1  |
+| Llama 3-V 70B                | 60.6 / -          | -         | -        | 93.0 | 83.2    | 92.2   | 83.4    | -           | 79.1  |
+| Llama 3-V 405B               | 64.5 / -          | -         | -        | 94.1 | 85.8    | 92.6   | 84.8    | -           | 80.2  |
+| InternVL2-Llama3-76B         | 55.2 / -          | 65.5      | 839      | 94.8 | 88.4    | 94.1   | 84.4    | 72.2        | -     |
+| GPT-4V                       | 56.8 / 55.7       | 49.9      | 645      | 78.2 | 78.5    | 88.4   | 78.0    | 61.4        | 77.2  |
+| GPT-4o                       | 69.1 / -          | 63.8      | 736      | 94.2 | 85.7    | 92.8   | -       | -           | -     |
+| Claude 3.5 Sonnet            | 68.3 / -          | 67.7      | 788      | 94.7 | 90.8    | 95.2   | -       | -           | -     |
+| Gemini 1.5 Pro (Aug 2024)    | 62.2 / -          | 63.9      | 754      | 94.4 | 87.2    | 93.1   | 78.7    | 70.4        | 80.2  |
+
+
+## Model Architectures
+
+**Network Architecture:** Decoder-Only Transformer 
+
+### Input
+**Input Type(s):** Text, Image <br>
+**Input Format(s):** String, [Pillow Library-Supported Formats](https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html) <br>
+**Input Dimensions:** One-Dimensional (1D), Two Dimensional (2D) <br>
+**Other Properties Related to Input:** Maximum Token Length = 128K Tokens <br>
+
+### Output
+**Output Type(s):** Text <br>
+**Output Format:** String <br>
+**Model Output:** 1D <br>
+**Other Properties Related to Output:** None <br> 
+
+## How to use
+
+For training code, please refer to [Megatron-LM](https://github.com/NVIDIA/Megatron-LM/tree/main/examples/multimodal/nvlm).
+
+
+### Prepare the environment
+
+We provide a docker build file in the [Dockerfile](https://github.com/NVIDIA/Megatron-LM/blob/main/examples/multimodal/Dockerfile) for reproduction. 
+
+### Evaluation
+
+Run the [text generation script](https://github.com/NVIDIA/Megatron-LM/blob/main/examples/multimodal/nvlm/run_text_generation_qwen20_72b_internvit_6b.sh).
+
+```
+examples/multimodal/nvlm/run_text_generation_qwen20_72b_internvit_6b.sh --input-image-path /path/to/input/images --output-path /some/output/directory \
+    --model-path /path/to/model.pt --gt-path /path/to/groundtruth/file --task generation-task-name --use-tiling
+```
+
+where `--task generation-task-name` is the name of the evaluation benchmark such as `captioning`, `MMMU` or `TextVQA`.
+
+Then, run one of the evaluation scripts from `examples/multimodal`. For example
+
+```
+python examples/multimodal/evaluate_mmmu.py --input-path /output/directory/from/generation
+```
+
+## Software Integration
+**Runtime Engine(s)** 
+* PyTorch <br>
+
+**Supported Hardware Microarchitecture Compatibility:** <br>
+* NVIDIA Hopper <br>
+
+**[Preferred/Supported] Operating System(s):** <br>
+* Linux <br>
+
+## Inference
+**Engine:** PyTorch <br>
+**Test Hardware:** <br>
+* H100 <br>
+
+## Model Version(s)
+* v1.0-D (NVLM-D)
+
+## Training, Testing, and Evaluation Datasets 
+
+### Pre-Training Dataset
+
+**Link** <br>
+* [See Table 4](https://arxiv.org/abs/2409.11402) <br>
+
+**Data Collection Method by dataset** <br>
+* Hybrid: Automated, Human, Synthetic, Unknown <br>
+
+**Labeling Method by dataset** <br>
+* Hybrid: Automated, Human, Synthetic, Unknown <br>
+
+**Properties** 
+* Trained on image captions, image-text pairs, natural images, charts, documents, scene descriptions, and mathematical reasoning. <br>
+
+### Supervised Fine-Tuning Dataset
+**Link** <br>
+* [See Table 6](https://arxiv.org/abs/2409.11402) <br>
+
+**Data Collection Method by dataset** <br>
+* Hybrid: Automated, Human, Synthetic, Unknown <br>
+
+**Labeling Method by dataset** <br>
+* Hybrid: Automated, Human, Synthetic, Unknown <br>
+
+**Properties** 
+* Trained on image captions; general knowledge; image-text pairs; natural images; charts; diagrams; documents; scene descriptions; science diagrams, lessons, textbook data, and question-answer pairs; visual instruction tuning; and mathematical reasoning. <br>
+
+### Evaluation Dataset
+**Link** <br>
+* [See Section 6.1, "Benchmark"](https://arxiv.org/abs/2409.11402) <br>
+
+**Data collection method by dataset** <br>
+* Human <br>
+
+**Labeling method by dataset** <br>
+* Human <br>
+
+**Properties** <br>
+* Evaluated on general knowledge, visual answering, chart understanding, table, optical character recognition, and mathematical reasoning. <br> 
+
+
+## Correspondence to
+Wenliang Dai* (wdai@nvidia.com), Nayeon Lee* (nayeonl@nvidia.com), Boxin Wang* (boxinw@nvidia.com), Zhuolin Yang* (zhuoliny@nvidia.com), Wei Ping* (wping@nvidia.com)
+
+*Equal contribution
+
+## Citation
+<pre>
+@article{nvlm2024,
+  title={NVLM: Open Frontier-Class Multimodal LLMs},
+  author={Dai, Wenliang and Lee, Nayeon and Wang, Boxin and Yang, Zhuolin and Liu, Zihan and Barker, Jon and Rintamaki, Tuomas and Shoeybi, Mohammad and Catanzaro, Bryan and Ping, Wei},
+  journal={arXiv preprint},
+  year={2024}}
+</pre>
+
+
+## Ethical Considerations
+NVIDIA believes Trustworthy AI is a shared responsibility and we have established policies and practices to enable development for a wide array of AI applications.  When downloaded or used in accordance with our terms of service, developers should work with their internal model team to ensure this model meets requirements for the relevant industry and use case and addresses unforeseen product misuse.    
+
+Please report security vulnerabilities or NVIDIA AI Concerns [here](https://www.nvidia.com/en-us/support/submit-security-vulnerability/).
+