README.md

---
license: apache-2.0
datasets:
- NeelNanda/pile-10k
---

## Model Details

This model is an int4 model with group_size 128 of [Qwen/Qwen2.5-0.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-0.5B-Instruct) generated by [intel/auto-round](https://github.com/intel/auto-round), auto-round is needed to run this model

## How To Use

### INT4 Inference



```python
##git clone https://github.com/intel/auto-round.git
##cd auto-round && pip install -vvv --no-build-isolation -e .
from auto_round import AutoHfQuantizer ##must import
import torch
from transformers import AutoModelForCausalLM,AutoTokenizer
quantized_model_dir = "Intel/Qwen2.5-0.5B-Instruct-int4-inc"
tokenizer = AutoTokenizer.from_pretrained(quantized_model_dir)

model = AutoModelForCausalLM.from_pretrained(
    quantized_model_dir,
    torch_dtype='auto',
    device_map="auto",
)

##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}
]

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=50,  ##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)

##prompt = "There is a girl who likes adventure,"
##That's great! What kind of adventure does she like?

##prompt = "Which one is bigger, 9.11 or 9.8"
##To determine which number is larger between 9.11 and 9.8, you can compare them directly:
##1. Start with the numbers: 9.11 and 9.8.
##2. Compare their digits from left to


##prompt = "Once upon a time,"
##once upon a time, there was a young girl named Lily who lived in a small village nestled among the rolling hills of England. She had always been fascinated by nature and the beauty of the world around her.One day, while exploring the woods near\

##prompt = "请介绍一下阿里巴巴公司"
##阿里巴巴集团是一家全球领先的电子商务和科技企业，成立于1999年。阿里巴巴集团总部位于中国杭州，并在全球范围内拥有超过20个运营中心。
##阿里巴巴集团的业务范围包括：
##1. 电子商务：阿里巴巴集团是全球

```

### Evaluate the model 

pip3 install lm-eval==0.4.4

```bash
git clone https://github.com/intel/auto-round
cd auto-round
python -m auto_round --model "Intel/Qwen2.5-0.5B-Instruct-int4-inc" --eval --eval_bs 16  --tasks lambada_openai,hellaswag,piqa,winogrande,truthfulqa_mc1,openbookqa,boolq,arc_easy,arc_challenge,mmlu,gsm8k,cmmlu,ceval-valid
```

| Metric         | BF16   | INT4(group_size 128)   | INT4(group_size 32)   |
|:-------------- | :----: | :----: |:------:|
| Avg            | 0.4637 | 0.4496 | 0.4512 |
| mmlu           | 0.4587 | 0.4440 | 0.4452 |
| cmmlu          | 0.5036 | 0.4580 | 0.4683 |
| ceval-valid    | 0.5312 | 0.4844 | 0.5015 |
| lambada_openai | 0.5015 | 0.4524 | 0.4768 |
| hellaswag      | 0.4064 | 0.3931 | 0.3976 |
| winogrande     | 0.5604 | 0.5683 | 0.5556 |
| piqa           | 0.7035 | 0.7008 | 0.7089 |
| truthfulqa_mc1 | 0.2693 | 0.2583 | 0.2570 |
| openbookqa     | 0.2400 | 0.2360 | 0.2340 |
| boolq          | 0.6798 | 0.6826 | 0.6676 |
| arc_easy       | 0.6557 | 0.6536 | 0.6334 |
| arc_challenge  | 0.3063 | 0.2935 | 0.2927 |
| gsm8k 5 shots  | 0.2115 | 0.2191 | 0.2274 |





### Reproduce the model

Here is the sample command to reproduce the model. We observed a larger accuracy drop in Chinese tasks and recommend using a high-quality Chinese dataset for calibration. However, we did not achieve better accuracy with some public datasets.

```bash
git clone https://github.com/intel/auto-round
cd auto-round
python -m auto_round \
--model_name  Qwen/Qwen2.5-0.5B-Instruct \
--device 0 \
--group_size 128 \
--nsamples 512 \
--bits 4 \
--iter 1000 \
--disable_eval \
--model_dtype "float16" \
--format '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)
* Intel Extension for Transformers [link](https://github.com/intel/intel-extension-for-transformers)

## 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)