Update README.md

README.md

@@ -0,0 +1,87 @@
+---
+license: mit
+tags:
+ - ONNX
+ - DML
+ - ONNXRuntime
+ - phi3
+ - custom_code
+---
+
+# Phi-3 Vision-128k-Instruct ONNX models
+
+<!-- Provide a quick summary of what the model is/does. -->
+This repository hosts the optimized versions of [Phi-3-vision-128k-instruct](https://aka.ms/phi3-vision-128k-instruct) to accelerate inference with ONNX Runtime for your CPU and GPU.
+
+Phi-3 Vision is a lightweight, state-of-the-art open multimodal model built upon datasets that include synthetic data and filtered publicly available web data with a focus on very high-quality, reasoning dense data both on text and vision. The model belongs to the Phi-3 model family, and the multimodal version supports up to 128K context length (in tokens). The base model has undergone a rigorous enhancement process, incorporating both supervised fine-tuning and direct preference optimization, to ensure precise instruction adherence and robust safety measures. 
+
+Optimized variants of the Phi-3 Vision models are published here in [ONNX](https://onnx.ai) format to run with [ONNX Runtime](https://onnxruntime.ai/) on CPU and GPU across devices, including server platforms, Windows, Linux and Mac desktops, and mobile CPUs, with the precision best suited to each of these targets.
+
+## ONNX Models 
+
+Here are some of the optimized configurations we have added:  
+
+1. ONNX model for INT4 CPU: ONNX model for CPUs using int4 quantization via RTN.
+2. ONNX model for INT4 GPU: ONNX model for GPUs using int4 quantization via RTN.
+
+## How to Get Started with the Model
+To support the Phi-3 models across a range of devices, platforms, and EP backends, we introduce a new API to wrap several aspects of generative AI inferencing. This API makes it easy to drag and drop LLMs straight into your app. To run the early version of these models with ONNX, follow the steps [here](https://aka.ms/run-phi3-v-onnx).
+
+## Hardware Supported
+
+The models are tested on:
+- Intel(R) Core(TM) i9-10920X CPU @ 3.50GHz 
+- 1 A100 GPU, SKU: Standard_ND96amsr_A100_v4 (CUDA)
+- GPU SKU: RTX 4080 (DirectML)
+
+Minimum Configuration Required:
+- CPU machine with 16GB RAM
+- CUDA: NVIDIA GPU with [Compute Capability](https://developer.nvidia.com/cuda-gpus) >= 7.0
+- Windows: DirectX 12-capable GPU and a minimum of 10GB of combined RAM
+
+### Model Description
+
+- **Developed by:**  Microsoft
+- **Model type:** ONNX
+- **Language(s) (NLP):** Python, C, C++
+- **License:** MIT
+- **Model Description:** This is a conversion of the Phi-3 Vision-128K-Instruct model for ONNX Runtime inference.
+
+## Additional Details
+- [**Phi-3 Small, Medium, and Vision Blog**](https://aka.ms/phi3_ONNXBuild24) and [**Phi-3 Mini Blog**](https://aka.ms/phi3-optimizations) 
+- [**Phi-3 Model Blog Link**](https://aka.ms/phi3blog-april)
+- [**Phi-3 Model Card**](https://aka.ms/phi3-vision-128k-instruct)
+- [**Phi-3 Technical Report**](https://aka.ms/phi3-tech-report)
+- [**Phi-3 on Azure AI Studio**](https://aka.ms/phi3-azure-ai)
+
+## Performance Metrics
+The performance of the ONNX vision model is similar to [Phi-3-mini-128k-instruct-onnx](https://huggingface.co/microsoft/Phi-3-mini-128k-instruct-onnx) during token generation.
+
+## Base Model Usage and Considerations
+**Primary use cases**
+
+The model is intended for broad commercial and research use in English. The model provides uses for general purpose AI systems and applications with visual and text input capabilities which require 
+
+1) memory/compute constrained environments;
+2) latency bound scenarios;
+3) general image understanding;
+4) OCR;
+5) chart and table understanding.
+
+Our model is designed to accelerate research on efficient language and multimodal models, for use as a building block for generative AI powered features.
+
+**Use case considerations**
+
+Our models are not specifically designed or evaluated for all downstream purposes. Developers should consider common limitations of language models as they select use cases, and evaluate and mitigate for accuracy, safety, and fairness before using within a specific downstream use case, particularly for high-risk scenarios.
+
+Developers should be aware of and adhere to applicable laws or regulations (including privacy, trade compliance laws, etc.) that are relevant to their use case. 
+
+Nothing contained in this Model Card should be interpreted as or deemed a restriction or modification to the license the model is released under.
+
+## Appendix
+
+## Model Card Contact
+parinitarahi, kvaishnavi, natke
+
+## Contributors
+Kunal Vaishnavi, Sunghoon Choi, Yufeng Li, Baiju Meswani, Sheetal Arun Kadam, Rui Ren, Natalie Kershaw, Parinita Rahi, Patrice Vignola, Xiang Zhang, Chai Chaoweeraprasit, Logan Iyer, Vicente Rivera, Jacques Van Rhyn