fix(root): Updates readme.

README.md

@@ -12,8 +12,8 @@ tags:
 
 ## Model Summary
 
-Phi-3 Mini-4K-Instruct is a 3.8B parameters, lightweight, state-of-the-art open model built upon datasets used for Phi-2 - synthetic data and filtered websites - with a focus on very high-quality, reasoning dense data.
-The model belongs to the Phi-3 model family, and the Mini version comes in two variants [4K](https://huggingface.co/microsoft/Phi-3-mini-4k-instruct) and [128K](https://huggingface.co/microsoft/Phi-3-mini-128k-instruct) which is the context length (in tokens) it can support. 
+Phi-3 Mini-4K-Instruct is a 3.8B parameters, lightweight, state-of-the-art open model built upon datasets used for Phi-2 - synthetic data and filtered websites - with a focus on very high-quality, reasoning dense data. The model belongs to the Phi-3 model family, and the Mini version comes in two variants [4K](https://huggingface.co/microsoft/Phi-3-mini-4k-instruct) and [128K](https://huggingface.co/microsoft/Phi-3-mini-128k-instruct) which is the context length (in tokens) it can support.
+
 The model underwent a rigorous enhancement process, incorporating both supervised fine-tuning and direct preference optimization to ensure precise instruction adherence and robust safety measures.
 When assessed against benchmarks testing common sense, language understanding, math, code, long context and logical reasoning, Phi-3 Mini-4K-Instruct showcased a robust and state-of-the-art performance among models with less than 13 billion parameters.
 
@@ -22,14 +22,15 @@ Resources and Technical Documentation:
 + [Phi-3 Microsoft Blog](https://aka.ms/phi3blog-april)
 + [Phi-3 Technical Report](https://aka.ms/phi3-tech-report)
 + [Phi-3 on Azure AI Studio](https://aka.ms/phi3-azure-ai)
-+ Phi-3 GGUF: [4K](https://aka.ms/phi3-mini-4k-instruct-gguf)
-+ Phi-3 ONNX: [4K](https://aka.ms/phi3-mini-4k-instruct-onnx)
++ Phi-3 GGUF: [4K](https://aka.ms/Phi3-mini-4k-instruct-gguf)
++ Phi-3 ONNX: [4K](https://aka.ms/Phi3-mini-4k-instruct-onnx)
 
 ## Intended Uses
 
 **Primary use cases**
 
-The model is intended for commercial and research use in English. The model provides uses for applications which require 
+The model is intended for commercial and research use in English. The model provides uses for applications which require:
+
 1) Memory/compute constrained environments
 2) Latency bound scenarios
 3) Strong reasoning (especially math and logic)
@@ -38,8 +39,8 @@ Our model is designed to accelerate research on language and multimodal models,
 
 **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 fariness 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. 
+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 fariness 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.  
 
 ## How to Use
@@ -54,7 +55,7 @@ The current `transformers` version can be verified with: `pip list | grep transf
 
 ### Chat Format:
 
-Given the nature of the training data, the Phi-3-mini-4K-instruct model is best suited for prompts using the chat format as follows. You can provide the prompt as a question:
+Given the nature of the training data, the Phi-3 Mini-4K-Instruct model is best suited for prompts using the chat format as follows. You can provide the prompt as a question:
 
 ```markdown
 <|system|>
@@ -66,7 +67,7 @@ How to explain Internet for a medieval knight?
 <|assistant|>
 ```
 
-where the model generates the text after "<|assistant|>" . In case of few-shots prompt, the prompt can be formatted as the following:
+where the model generates the text after `<|assistant|>` . In case of few-shots prompt, the prompt can be formatted as the following:
 
 ```markdown
 <|system|>
@@ -92,19 +93,14 @@ import torch
 from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
 
 torch.random.manual_seed(0)
-token = "your huggingface token here"
-
-model_id = "microsoft/Phi-3-mini-4k-instruct"
 
 model = AutoModelForCausalLM.from_pretrained(
-    model_id, 
+    "microsoft/Phi-3-mini-4k-instruct", 
     device_map="cuda", 
     torch_dtype="auto", 
     trust_remote_code=True, 
-    token=token
 )
-
-tokenizer = AutoTokenizer.from_pretrained(model_id, token=token)
+tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
 
 messages = [
     {"role": "system", "content": "You are a helpful digital assistant. Please provide safe, ethical and accurate information to the user."},
@@ -132,21 +128,24 @@ output = pipe(messages, **generation_args)
 print(output[0]['generated_text'])
 ```
 
-Note that by default the model use flash attention which requires certain types of GPU to run. If you want to run the model on
+Note that by default the model use flash attention which requires certain types of GPU to run. If you want to run the model on:
+
 + V100 or earlier generation GPUs: call `AutoModelForCausalLM.from_pretrained()`  with `attn_implementation="eager"`
-+ CPU: use the **GGUF** quantized models [4K](https://aka.ms/phi3-mini-4k-instruct-gguf)
-+ Optimized inference: use the **ONNX** models [4K](https://aka.ms/phi3-mini-4k-instruct-onnx)
++ CPU: use the **GGUF** quantized models [4K](https://aka.ms/Phi3-mini-4k-instruct-gguf)
++ Optimized inference: use the **ONNX** models [4K](https://aka.ms/Phi3-mini-4k-instruct-onnx)
 
 ## Responsible AI Considerations
 
-Like other language models, the Phi series models can potentially behave in ways that are unfair, unreliable, or offensive. Some of the limiting behaviors to be aware of include:  
+Like other language models, the Phi series models can potentially behave in ways that are unfair, unreliable, or offensive. Some of the limiting behaviors to be aware of include:
+
 + Quality of Service: the Phi models are trained primarily on English text. Languages other than English will experience worse performance. English language varieties with less representation in the training data might experience worse performance than standard American English.   
 + Representation of Harms & Perpetuation of Stereotypes: These models can over- or under-represent groups of people, erase representation of some groups, or reinforce demeaning or negative stereotypes. Despite safety post-training, these limitations may still be present due to differing levels of representation of different groups or prevalence of examples of negative stereotypes in training data that reflect real-world patterns and societal biases. 
 + Inappropriate or Offensive Content: these models may produce other types of inappropriate or offensive content, which may make it inappropriate to deploy for sensitive contexts without additional mitigations that are specific to the use case. 
 + Information Reliability: Language models can generate nonsensical content or fabricate content that might sound reasonable but is inaccurate or outdated.  
 + Limited Scope for Code: Majority of Phi-3 training data is based in Python and use common packages such as "typing, math, random, collections, datetime, itertools". If the model generates Python scripts that utilize other packages or scripts in other languages, we strongly recommend users manually verify all API uses.   
 
-Developers should apply responsible AI best practices and are responsible for ensuring that a specific use case complies with relevant laws and regulations (e.g. privacy, trade, etc.). Important areas for consideration include: 
+Developers should apply responsible AI best practices and are responsible for ensuring that a specific use case complies with relevant laws and regulations (e.g. privacy, trade, etc.). Important areas for consideration include:
+
 + Allocation: Models may not be suitable for scenarios that could have consequential impact on legal status or the allocation of resources or life opportunities (ex: housing, employment, credit, etc.) without further assessments and additional debiasing techniques.
 + High-Risk Scenarios: Developers should assess suitability of using models in high-risk scenarios where unfair, unreliable or offensive outputs might be extremely costly or lead to harm. This includes providing advice in sensitive or expert domains where accuracy and reliability are critical (ex: legal or health advice). Additional safeguards should be implemented at the application level according to the deployment context. 
 + Misinformation: Models may produce inaccurate information. Developers should follow transparency best practices and inform end-users they are interacting with an AI system. At the application level, developers can build feedback mechanisms and pipelines to ground responses in use-case specific, contextual information, a technique known as Retrieval Augmented Generation (RAG).   
@@ -158,7 +157,7 @@ Developers should apply responsible AI best practices and are responsible for en
 
 ### Model
 
-* Architecture: Phi-3 Mini has 3.8B parameters and is a dense decoder-only Transformer model. The model is fine-tuned with Supervised fine-tuning (SFT) and Direct Preference Optimization (DPO) to ensure alignment with human preferences and safety guidlines.
+* Architecture: Phi-3 Mini-4K-Instruct has 3.8B parameters and is a dense decoder-only Transformer model. The model is fine-tuned with Supervised fine-tuning (SFT) and Direct Preference Optimization (DPO) to ensure alignment with human preferences and safety guidlines.
 * Inputs: Text. It is best suited for prompts using chat format.
 * Context length: 4K tokens
 * GPUs: 512 H100-80G
@@ -182,11 +181,13 @@ A basic example of multi-GPUs supervised fine-tuning (SFT) with TRL and Accelera
 ## Benchmarks
 
 We report the results for Phi-3-Mini-4K-Instruct on standard open-source benchmarks measuring the model's reasoning ability (both common sense reasoning and logical reasoning). We compare to Phi-2, Mistral-7b-v0.1, Mixtral-8x7b, Gemma 7B, Llama-3-8B-Instruct, and GPT-3.5.
-All the reported numbers are produced with the exact same pipeline to ensure that the numbers are comparable.
-These numbers might differ from other published numbers due to slightly different choices in the evaluation.
+
+All the reported numbers are produced with the exact same pipeline to ensure that the numbers are comparable. These numbers might differ from other published numbers due to slightly different choices in the evaluation.
+
 As is now standard, we use few-shot prompts to evaluate the models, at temperature 0. 
 The prompts and number of shots are part of a Microsoft internal tool to evaluate language models, and in particular we did no optimization to the pipeline for Phi-3.
 More specifically, we do not change prompts, pick different few-shot examples, change prompt format, or do any other form of optimization for the model.
+
 The number of k–shot examples is listed per-benchmark. 
 
 |   | Phi-3-Mini-4K-In<br>3.8b | Phi-3-Small<br>7b (preview) | Phi-3-Medium<br>14b (preview) | Phi-2<br>2.7b | Mistral<br>7b | Gemma<br>7b | Llama-3-In<br>8b | Mixtral<br>8x7b | GPT-3.5<br>version 1106 |
@@ -220,10 +221,13 @@ The number of k–shot examples is listed per-benchmark.
 
 ## Cross Platform Support
 
-ONNX runtime ecosystem now supports Phi3 mini models across platforms and hardware.  You can find the optimized ONNX models at https://aka.ms/Phi3-ONNX-HF. 
-Optimized phi-3 models are also published here in ONNX format, to run with ONNX Runtime 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. DirectML support lets developers bring hardware acceleration to Windows devices at scale across AMD, Intel, and NVIDIA GPUs.  
-Along with DirectML, ONNX Runtime provides cross platform support for Phi3 mini across a range of devices CPU, GPU, and mobile. 
+ONNX runtime ecosystem now supports Phi3 mini models across platforms and hardware. You can find the optimized ONNX models [here](https://aka.ms/Phi3-ONNX-HF).
+
+Optimized Phi-3 models are also published here in ONNX format, to run with ONNX Runtime 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. DirectML support lets developers bring hardware acceleration to Windows devices at scale across AMD, Intel, and NVIDIA GPUs.  
+Along with DirectML, ONNX Runtime provides cross platform support for Phi-3 across a range of devices CPU, GPU, and mobile.
+
 Here are some of the optimized configurations we have added: 
+
 1. ONNX models for int4 DML: Quantized to int4 via AWQ
 2. ONNX model for fp16 CUDA
 3. ONNX model for int4 CUDA: Quantized to int4 via RTN
@@ -231,7 +235,7 @@ Here are some of the optimized configurations we have added:
 
 ## License
 
-The model is licensed under the [MIT license](https://huggingface.co/microsoft/phi-3-mini-4k/resolve/main/LICENSE).
+The model is licensed under the [MIT license](https://huggingface.co/microsoft/Phi-3-mini-4k/resolve/main/LICENSE).
 
 ## Trademarks