Update README.md

README.md

@@ -1,3 +1,165 @@
----
-license: llama3.3
----
+---
+license: llama3.3
+datasets:
+- NeelNanda/pile-10k
+---
+
+
+## Model Details
+
+This model is an int2  model with group_size 32and symmetric quantization of [meta-llama/Llama-3.3-70B-Instruct](https://huggingface.co/meta-llama/Llama-3.3-70B-Instruct) generated by [intel/auto-round](https://github.com/intel/auto-round). Load the model with revision `3ba7fab` to use AutoGPTQ format. We may consider changing the group_size or adopting mixed-bit quantization in the future to address the significant accuracy gap observed in certain tasks
+
+## How To Use
+
+### Inference on CPU/HPU/CUDA
+
+HPU: docker image with Gaudi Software Stack is recommended, please refer to following script for environment setup. More details can be found in [Gaudi Guide](https://docs.habana.ai/en/latest/Installation_Guide/Bare_Metal_Fresh_OS.html#launch-docker-image-that-was-built).
+
+```python
+from auto_round import AutoHfQuantizer ##must import for auto-round format
+import torch
+from transformers import AutoModelForCausalLM,AutoTokenizer
+quantized_model_dir = "OPEA/Llama-3.3-70B-Instruct-int4-sym-inc"
+tokenizer = AutoTokenizer.from_pretrained(quantized_model_dir)
+
+model = AutoModelForCausalLM.from_pretrained(
+    quantized_model_dir,
+    torch_dtype='auto',
+    device_map="auto",
+    ##revision="3ba7fab", ##AutoGPTQ format
+)
+
+##import habana_frameworks.torch.core as htcore ## uncommnet it for HPU
+##import habana_frameworks.torch.hpu as hthpu ## uncommnet it for HPU
+##model = model.to(torch.bfloat16).to("hpu") ## uncommnet it for HPU
+
+prompt = "There is a girl who likes adventure,"
+messages = [
+    {"role": "system", "content": "You are a helpful assistant."},
+    {"role": "user", "content": prompt}
+]
+
+tokenizer = AutoTokenizer.from_pretrained(quantized_model_dir)
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
+
+generated_ids = model.generate(
+    model_inputs.input_ids,
+    max_new_tokens=200,  ##change this to align with the official usage
+    do_sample=False  ##change this to align with the official usage
+)
+generated_ids = [
+output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+print(response)
+##INT2:
+## That sounds exciting! What kind of adventures does she enjoy? Is she into hiking, traveling, trying new foods, or something else? Tell me more about her!
+
+##BF16:
+## That sounds like the start of an exciting story. The girl who likes adventure, let's call her Alex, is probably always looking for her next thrill. She might enjoy activities like hiking, rock climbing, or exploring new places. Perhaps she's always been drawn to the unknown and loves to challenge herself to try new things.
+
+prompt = "Which one is larger, 9.11 or 9.8"
+##INT2:
+## 9.11 is larger than 9.8.
+
+##BF16:
+## 9.11 is larger than 9.8.
+
+prompt = "How many r in strawberry."
+##INT2:
+## There are 2 R's in the word "strawberry".
+
+##BF16:
+## There are 2 R's in the word "strawberry".
+
+prompt = "Once upon a time,"
+##INT2:
+## It seems like you're starting a story! I'd love to hear more. Please go on...
+
+##BF16:
+##  ...in a far-off kingdom, where the sun dipped into the horizon and painted the sky with hues of crimson and gold, there lived a young adventurer named Sophia. She had hair as black as the night and eyes as blue as the clearest summer sky. Sophia was known throughout the land for her bravery, kindness, and insatiable curiosity.
+## What would you like to happen next in the story? Would you like Sophia to:
+## A) Embark on a quest to find a legendary treasure
+## B) Encounter a mysterious stranger with a hidden agenda
+## C) Discover a magical forest filled with ancient secrets
+## D) Something entirely different (please specify)
+## Choose your response to progress the story!
+```
+
+
+
+### Evaluate the model
+
+pip3 install lm-eval==0.4.5
+
+```bash
+ auto-round --eval --model "OPEA/Llama-3.3-70B-Instruct-int4-sym-inc" --eval_bs 64  --tasks leaderboard_mmlu_pro,leaderboard_ifeval,lambada_openai,hellaswag,piqa,winogrande,truthfulqa_mc1,openbookqa,boolq,arc_easy,arc_challenge,mmlu,gsm8k
+```
+
+|           Metric           |           BF16           |      INT2G32      |
+| :------------------------: | :----------------------: | :---------------: |
+|            avg             |          0.7023          |                   |
+| leaderboard_mmlu_pro 5shot |          0.5484          |      0.4384       |
+|            mmlu            |          0.8195          |      0.7142       |
+|       lambada_openai       |          0.7528          |      0.7013       |
+|         hellaswag          |          0.6575          |      0.5576       |
+|         winogrande         |          0.7869          |      0.7080       |
+|            piqa            |          0.8303          |      0.7797       |
+|       truthfulqa_mc1       |          0.4284          |      0.3586       |
+|         openbookqa         |          0.3720          |      0.3000       |
+|           boolq            |          0.8865          |      0.8339       |
+|          arc_easy          |          0.8624          |      0.8064       |
+|       arc_challenge        |          0.6109          |      0.5188       |
+|     leaderboard_ifeval     | 0.6661=(0.7110+0.6211)/2 | (0.5959+0.4603)/2 |
+| gsm8k(5shot) strict match  |          0.9083          |                   |
+
+## Generate the model
+
+Here is the sample command to generate the model. We found that AutoRound is highly unstable for 2-bit quantization of this model, requiring careful tuning of certain hyperparameters.  We recommend mixed-bits quantization or trying some other more complex tuning algorithms.
+
+```bash
+auto-round  \
+--model meta-llama/Llama-3.3-70B-Instruct \
+--device 0 \
+--group_size 32 \
+--nsamples 1024 \
+--bits 4 \
+--iter 2000 \
+--disable_eval \
+--enable_norm_bias_tuning \
+--low_gpu_mem_usage \
+--format 'auto_gptq,auto_round' \
+--output_dir "./tmp_autoround" 
+```
+
+
+
+## Ethical Considerations and Limitations
+
+The model can produce factually incorrect output, and should not be relied on to produce factually accurate information. Because of the limitations of the pretrained model and the finetuning datasets, it is possible that this model could generate lewd, biased or otherwise offensive outputs.
+
+Therefore, before deploying any applications of the model, developers should perform safety testing.
+
+## Caveats and Recommendations
+
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model.
+
+Here are a couple of useful links to learn more about Intel's AI software:
+
+- Intel Neural Compressor [link](https://github.com/intel/neural-compressor)
+
+## Disclaimer
+
+The license on this model does not constitute legal advice. We are not responsible for the actions of third parties who use this model. Please consult an attorney before using this model for commercial purposes.
+
+## Cite
+
+@article{cheng2023optimize, title={Optimize weight rounding via signed gradient descent for the quantization of llms}, author={Cheng, Wenhua and Zhang, Weiwei and Shen, Haihao and Cai, Yiyang and He, Xin and Lv, Kaokao and Liu, Yi}, journal={arXiv preprint arXiv:2309.05516}, year={2023} }
+
+[arxiv](https://arxiv.org/abs/2309.05516) [github](https://github.com/intel/auto-round)