Update README.md

README.md

@@ -7,19 +7,66 @@ tags:
 # Phi-3-mini-128k-instruct-FP8
 
 ## Model Overview
-* <h3 style="display: inline;">Model Architecture:</h3> Based on and identical to the Phi-3-mini-128k-instruct architecture
-* <h3 style="display: inline;">Model Optimizations:</h3> Weights and activations quantized to FP8
-* <h3 style="display: inline;">Release Date:</h3> June 29, 2024
-* <h3 style="display: inline;">Model Developers:</h3> Neural Magic
+- **Model Architecture:** Phi-3
+  - **Input:** Text
+  - **Output:** Text
+- **Model Optimizations:**
+  - **Weight quantization:** FP8
+  - **Activation quantization:** FP8
+- **Intended Use Cases:** Intended for commercial and research use in English. Similarly to [Meta-Llama-3-8B-Instruct](https://huggingface.co/meta-llama/Meta-Llama-3-8B-Instruct), this models is intended for assistant-like chat.
+- **Out-of-scope:** Use in any manner that violates applicable laws or regulations (including trade compliance laws). Use in languages other than English.
+- **Release Date:** 6/29/2024
+- **Version:** 1.0
+- **Model Developers:** Neural Magic
 
-Phi-3-mini-128k-instruct quantized to FP8 weights and activations using per-tensor quantization through the [AutoFP8 repository](https://github.com/neuralmagic/AutoFP8), ready for inference with vLLM >= 0.5.0. 
-Calibrated with 512 UltraChat samples to achieve 100% performance recovery on the Open LLM Benchmark evaluations. 
-Reduces space on disk by ~50%.
-Part of the [FP8 LLMs for vLLM collection](https://huggingface.co/collections/neuralmagic/fp8-llms-for-vllm-666742ed2b78b7ac8df13127).
+Quantized version of [Phi-3-mini-128k-instruct](https://huggingface.co/microsoft/Phi-3-mini-128k-instruct).
+It achieves an average score of 68.99 on the [OpenLLM](https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard) benchmark (version 1), whereas the unquantized model achieves 69.13.
 
+### Model Optimizations
 
-## Usage and Creation
-Produced using [AutoFP8 with calibration samples from ultrachat](https://github.com/neuralmagic/AutoFP8/blob/147fa4d9e1a90ef8a93f96fc7d9c33056ddc017a/example_dataset.py).
+This model was obtained by quantizing the weights and activations of [Phi-3-mini-128k-instruct](https://huggingface.co/microsoft/Phi-3-mini-128k-instruct) to FP8 data type, ready for inference with vLLM >= 0.5.1.
+This optimization reduces the number of bits per parameter from 16 to 8, reducing the disk size and GPU memory requirements by approximately 50%.
+
+Only the weights and activations of the linear operators within transformers blocks are quantized. Symmetric per-tensor quantization is applied, in which a linear scaling per output dimension maps the FP8 representations of the quantized weights and activations.
+[AutoFP8](https://github.com/neuralmagic/AutoFP8) is used for quantization with 512 sequences of UltraChat.
+
+## Deployment
+
+### Use with vLLM
+
+This model can be deployed efficiently using the [vLLM](https://docs.vllm.ai/en/latest/) backend, as shown in the example below.
+
+```python
+from vllm import LLM, SamplingParams
+from transformers import AutoTokenizer
+
+model_id = "neuralmagic/Phi-3-mini-128k-instruct-FP8"
+
+sampling_params = SamplingParams(temperature=0.6, top_p=0.9, max_tokens=256)
+
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+
+messages = [
+    {"role": "system", "content": "You are a pirate chatbot who always responds in pirate speak!"},
+    {"role": "user", "content": "Who are you?"},
+]
+
+prompts = tokenizer.apply_chat_template(messages, tokenize=False)
+
+llm = LLM(model=model_id)
+
+outputs = llm.generate(prompts, sampling_params)
+
+generated_text = outputs[0].outputs[0].text
+print(generated_text)
+```
+
+vLLM aslo supports OpenAI-compatible serving. See the [documentation](https://docs.vllm.ai/en/latest/) for more details.
+
+## Creation
+
+This model was created by applying [AutoFP8 with calibration samples from ultrachat](https://github.com/neuralmagic/AutoFP8/blob/147fa4d9e1a90ef8a93f96fc7d9c33056ddc017a/example_dataset.py), as presented in the code snipet below.
+Although AutoFP8 was used for this particular model, Neural Magic is transitioning to using [llm-compressor](https://github.com/vllm-project/llm-compressor) which supports several quantization schemes and models not supported by AutoFP8.
 
 ```python
 from datasets import load_dataset
@@ -46,63 +93,99 @@ model.quantize(examples)
 model.save_quantized(quantized_model_dir)
 ```
 
-Evaluated through vLLM>=0.5.1 with the following script:
-
-```bash
-#!/bin/bash
-
-# Example usage:
-# CUDA_VISIBLE_DEVICES=0 ./eval_openllm.sh "neuralmagic/Phi-3-mini-128k-instruct-FP8" "tensor_parallel_size=1,max_model_len=4096,add_bos_token=True,gpu_memory_utilization=0.7"
-
-export MODEL_DIR=${1}
-export MODEL_ARGS=${2}
-
-declare -A tasks_fewshot=(
-    ["arc_challenge"]=25
-    ["winogrande"]=5
-    ["truthfulqa_mc2"]=0
-    ["hellaswag"]=10
-    ["mmlu"]=5
-    ["gsm8k"]=5
-)
-
-declare -A batch_sizes=(
-    ["arc_challenge"]="auto"
-    ["winogrande"]="auto"
-    ["truthfulqa_mc2"]="auto"
-    ["hellaswag"]="auto"
-    ["mmlu"]=1
-    ["gsm8k"]="auto"
-)
+## Evaluation
 
-for TASK in "${!tasks_fewshot[@]}"; do
-    NUM_FEWSHOT=${tasks_fewshot[$TASK]}
-    BATCH_SIZE=${batch_sizes[$TASK]}
-    lm_eval --model vllm \
-        --model_args pretrained=$MODEL_DIR,$MODEL_ARGS \
-        --tasks ${TASK} \
-        --num_fewshot ${NUM_FEWSHOT} \
-        --write_out \
-        --show_config \
-        --device cuda \
-        --batch_size ${BATCH_SIZE} \
-        --output_path="results/${TASK}"
-done
+The model was evaluated on the [OpenLLM](https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard) leaderboard tasks (version 1) with the [lm-evaluation-harness](https://github.com/EleutherAI/lm-evaluation-harness/tree/383bbd54bc621086e05aa1b030d8d4d5635b25e6) (commit 383bbd54bc621086e05aa1b030d8d4d5635b25e6) and the [vLLM](https://docs.vllm.ai/en/stable/) engine, using the following command:
+```
+lm_eval \
+  --model vllm \
+  --model_args pretrained="neuralmagic/Phi-3-mini-128k-instruct-FP8",dtype=auto,gpu_memory_utilization=0.4,add_bos_token=True,max_model_len=4096 \
+  --tasks openllm \
+  --batch_size auto
 ```
 
-
-## Evaluation
-
-Evaluated on the Open LLM Leaderboard evaluations through vLLM.
-
-### Open LLM Leaderboard evaluation scores
-|                      | Phi-3-mini-128k-instruct       | neuralmagic/Phi-3-mini-128k-instruct-FP8<br>(this model) |
-| :------------------: | :----------------------: | :------------------------------------------------: |
-| arc-c<br>25-shot     | 63.65                    | 64.24                                              |
-| hellaswag<br>10-shot | 79.76                    | 79.79                                              |
-| mmlu<br>5-shot       | 68.10                    | 67.93                                              |
-| truthfulqa<br>0-shot | 53.97                    | 53.50                                              |
-| winogrande<br>5-shot | 73.72                    | 74.11                                              |
-| gsm8k<br>5-shot      | 75.59                    | 74.37                                              |
-| **Average<br>Accuracy**  | **69.13**                    |              **68.99**                                      |
-| **Recovery**             | **100%**                     |              **99.80%**                                     |
+### Accuracy
+
+#### Open LLM Leaderboard evaluation scores
+<table>
+  <tr>
+   <td><strong>Benchmark</strong>
+   </td>
+   <td><strong>Phi-3-mini-128k-instruct</strong>
+   </td>
+   <td><strong>Phi-3-mini-128k-instruct-FP8(this model)</strong>
+   </td>
+   <td><strong>Recovery</strong>
+   </td>
+  </tr>
+  <tr>
+   <td>MMLU (5-shot)
+   </td>
+   <td>68.10
+   </td>
+   <td>67.93
+   </td>
+   <td>99.75%
+   </td>
+  </tr>
+  <tr>
+   <td>ARC Challenge (25-shot)
+   </td>
+   <td>63.65
+   </td>
+   <td>64.24
+   </td>
+   <td>100.9%
+   </td>
+  </tr>
+  <tr>
+   <td>GSM-8K (5-shot, strict-match)
+   </td>
+   <td>75.59
+   </td>
+   <td>74.37
+   </td>
+   <td>98.38%
+   </td>
+  </tr>
+  <tr>
+   <td>Hellaswag (10-shot)
+   </td>
+   <td>79.76
+   </td>
+   <td>79.79
+   </td>
+   <td>100.0%
+   </td>
+  </tr>
+  <tr>
+   <td>Winogrande (5-shot)
+   </td>
+   <td>73.72
+   </td>
+   <td>74.11
+   </td>
+   <td>100.5%
+   </td>
+  </tr>
+  <tr>
+   <td>TruthfulQA (0-shot)
+   </td>
+   <td>53.97
+   </td>
+   <td>53.50
+   </td>
+   <td>99.12%
+   </td>
+  </tr>
+  <tr>
+   <td><strong>Average</strong>
+   </td>
+   <td><strong>69.13</strong>
+   </td>
+   <td><strong>68.99</strong>
+   </td>
+   <td><strong>99.80%</strong>
+   </td>
+  </tr>
+</table>