Create README.md

README.md

@@ -0,0 +1,183 @@
+---
+tags:
+- fp8
+- vllm
+license: apache-2.0
+license_link: https://huggingface.co/datasets/choosealicense/licenses/blob/main/markdown/apache-2.0.md
+language:
+  - en
+base_model: ibm-granite/granite-3.1-2b-base
+library_name: transformers
+---
+
+# granite-3.1-2b-base-FP8-dynamic
+
+## Model Overview
+- **Model Architecture:** granite-3.1-2b-base
+  - **Input:** Text
+  - **Output:** Text
+- **Model Optimizations:**
+  - **Weight quantization:** FP8
+  - **Activation quantization:** FP8
+- **Release Date:** 1/8/2025
+- **Version:** 1.0
+- **Model Developers:** Neural Magic
+
+Quantized version of [ibm-granite/granite-3.1-2b-base](https://huggingface.co/ibm-granite/granite-3.1-2b-base).
+It achieves an average score of xxxx on the [OpenLLM](https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard) benchmark (version 1), whereas the unquantized model achieves xxxx.
+
+### Model Optimizations
+
+This model was obtained by quantizing the weights and activations of [ibm-granite/granite-3.1-2b-base](https://huggingface.co/ibm-granite/granite-3.1-2b-base) to FP8 data type, ready for inference with vLLM >= 0.5.2.
+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. 
+
+## 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 transformers import AutoTokenizer
+from vllm import LLM, SamplingParams
+
+max_model_len, tp_size = 4096, 1
+model_name = "neuralmagic-ent/granite-3.1-2b-base-FP8-dynamic"
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+llm = LLM(model=model_name, tensor_parallel_size=tp_size, max_model_len=max_model_len, trust_remote_code=True)
+sampling_params = SamplingParams(temperature=0.3, max_tokens=256, stop_token_ids=[tokenizer.eos_token_id])
+
+messages_list = [
+    [{"role": "user", "content": "Who are you? Please respond in pirate speak!"}],
+]
+
+prompt_token_ids = [tokenizer.apply_chat_template(messages, add_generation_prompt=True) for messages in messages_list]
+
+outputs = llm.generate(prompt_token_ids=prompt_token_ids, sampling_params=sampling_params)
+
+generated_text = [output.outputs[0].text for output in outputs]
+print(generated_text)
+```
+
+vLLM also supports OpenAI-compatible serving. See the [documentation](https://docs.vllm.ai/en/latest/) for more details.
+
+## Creation
+
+This model was created with [llm-compressor](https://github.com/vllm-project/llm-compressor) by running the code snippet below. 
+
+
+```python
+import argparse
+from transformers import AutoModelForCausalLM, AutoTokenizer
+from llmcompressor.modifiers.quantization import QuantizationModifier
+from llmcompressor.transformers import oneshot
+import os
+
+def main():
+    parser = argparse.ArgumentParser(description='Quantize a transformer model to FP8')
+    parser.add_argument('--model_id', type=str, required=True,
+                        help='The model ID from HuggingFace (e.g., "meta-llama/Meta-Llama-3-2b-base")')
+    parser.add_argument('--save_path', type=str, default='.',
+                        help='Custom path to save the quantized model. If not provided, will use model_name-FP8-dynamic')
+    args = parser.parse_args()
+
+    # Load model
+    model = AutoModelForCausalLM.from_pretrained(
+        args.model_id, device_map="auto", torch_dtype="auto", trust_remote_code=True,
+    )
+    tokenizer = AutoTokenizer.from_pretrained(args.model_id)
+
+    # Configure the quantization algorithm and scheme
+    recipe = QuantizationModifier(
+        targets="Linear", scheme="FP8_DYNAMIC", ignore=["lm_head"]
+    )
+
+    # Apply quantization
+    oneshot(model=model, recipe=recipe)
+
+    save_path = os.path.join(args.save_path, args.model_id.split("/")[1] + "-FP8-dynamic")
+    os.makedirs(save_path, exist_ok=True)
+
+    # Save to disk in compressed-tensors format
+    model.save_pretrained(save_path)
+    tokenizer.save_pretrained(save_path)
+    print(f"Model and tokenizer saved to: {save_path}")
+
+if __name__ == "__main__":
+    main()
+```
+
+## Evaluation
+
+The model was evaluated on OpenLLM Leaderboard [V1](https://huggingface.co/spaces/open-llm-leaderboard-old/open_llm_leaderboard) and on [HumanEval](https://github.com/neuralmagic/evalplus), using the following commands:
+
+OpenLLM Leaderboard V1:
+```
+lm_eval \
+  --model vllm \
+  --model_args pretrained="neuralmagic-ent/granite-3.1-2b-base-FP8-dynamic",dtype=auto,add_bos_token=True,max_model_len=4096,tensor_parallel_size=1,gpu_memory_utilization=0.8,enable_chunked_prefill=True,trust_remote_code=True \
+  --tasks openllm \
+  --write_out \
+  --batch_size auto \
+  --output_path output_dir \
+  --show_config
+```
+
+#### HumanEval
+##### Generation
+```
+python3 codegen/generate.py \
+  --model neuralmagic-ent/granite-3.1-2b-base-FP8-dynamic \
+  --bs 16 \
+  --temperature 0.2 \
+  --n_samples 50 \
+  --root "." \
+  --dataset humaneval
+```
+##### Sanitization
+```
+python3 evalplus/sanitize.py \
+  humaneval/neuralmagic-ent--granite-3.1-2b-base-FP8-dynamic_vllm_temp_0.2
+```
+##### Evaluation
+```
+evalplus.evaluate \
+  --dataset humaneval \
+  --samples humaneval/neuralmagic-ent--granite-3.1-2b-base-FP8-dynamic_vllm_temp_0.2-sanitized
+```
+
+### Accuracy
+
+#### OpenLLM Leaderboard V1 evaluation scores
+
+Here are the tables with all the numbers removed:
+
+| Metric                                  | ibm-granite/granite-3.1-2b-instruct             | neuralmagic-ent/granite-3.1-2b-base-FP8-dynamic |
+|-----------------------------------------|:---------------------------------:|:-------------------------------------------:|
+| ARC-Challenge (Acc-Norm, 25-shot)       | 55.63                             | 53.50                                      |
+| GSM8K (Strict-Match, 5-shot)            | 60.96                             | 46.10                                       |
+| HellaSwag (Acc-Norm, 10-shot)           | 75.21                             | 77.76                                      |
+| MMLU (Acc, 5-shot)                      | 54.38                             | 52.61                                        |
+| TruthfulQA (MC2, 0-shot)                | 55.93                             | 39.84                                         |
+| Winogrande (Acc, 5-shot)                | 69.67                             | 74.43                                        |
+| **Average Score**                       | **61.98**                         | **57.37**                                   |
+| **Recovery**                            | **100.00**                        | **99.52**                                   |
+
+| Metric                                  | ibm-granite/granite-3.1-2b-base             | neuralmagic-ent/granite-3.1-2b-base-FP8-dynamic |
+|-----------------------------------------|:---------------------------------:|:-------------------------------------------:|
+| IFEval (Inst Level Strict Acc, 0-shot)| 41.01                           | 0.4185                                         |
+| BBH (Acc-Norm, 3-shot)            | 40.19                             | 0.4854                                        |
+| Math-Hard (Exact-Match, 4-shot)   | 4.86                            | 0.0465                                       |
+| GPQA (Acc-Norm, 0-shot)           | 27.11                             | 0.2780                                        |
+| MUSR (Acc-Norm, 0-shot)           | 34.85                             | 0.3406                                         |
+| MMLU-Pro (Acc, 5-shot)            | 22.49                             | 0.2285                                        |
+| **Average Score**                 | **28.42**                         | **29.96**                                    |
+| **Recovery**                      | **100.00**                         | **105.42**                                    |
+
+#### HumanEval pass@1 scores
+| Metric                                  | ibm-granite/granite-3.1-2b-base             | neuralmagic-ent/granite-3.1-2b-base-FP8-dynamic |
+|-----------------------------------------|:---------------------------------:|:-------------------------------------------:|
+| HumanEval Pass@1                        | 30.00                                      | 30.40                                            |
+
+
+