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

## Model Details

This model is an int4 model with group_size 128 with quantized lm-head of [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2.5-14B-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 = "OPEA/Qwen2.5-14B-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! Adventure can be a wonderful way to explore the world, challenge oneself, and discover new things. What kind of adventures does she enjoy? Perhaps she likes hiking, traveling to new places, trying new activities, or maybe something else entirely

##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 the digits in each place value:
##- The whole number part of both numbers is 9.
##- For the decimal part:
##  - 9

##prompt = "Once upon a time,"
##Once upon a time, in a far-off land, there was a kingdom surrounded by lush green forests, sparkling rivers, and rolling hills. The people of this kingdom lived in harmony with nature and each other, under the wise rule of their king.

##prompt = "请介绍一下阿里巴巴公司"
##阿里巴巴集团创立于1999年，是以贸易作为发展起点，以数据作为核心驱动，并以技术作为基础支撑的公司。阿里巴巴集团业务包括核心电商、云计算、数字媒体及娱乐、创新项目四大板块。阿里巴巴

```

### Evaluate the model 

pip3 install lm-eval==0.4.2

```bash
git clone https://github.com/intel/auto-round
cd auto-round
python -m auto_round --model "OPEA/Qwen2.5-7B-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   |
|:-------------- | :----: | :----: |
| Avg            | 0.7271 | 0.7221 |
| mmlu           | 0.7891 | 0.7812 |
| cmmlu          | 0.8378 | 0.8257 |
| ceval-valid    | 0.8351 | 0.8276 |
| lambada_openai | 0.7343 | 0.7227 |
| hellaswag      | 0.6562 | 0.6509 |
| winogrande     | 0.7616 | 0.7585 |
| piqa           | 0.8139 | 0.8128 |
| truthfulqa_mc1 | 0.5153 | 0.5116 |
| openbookqa     | 0.3700 | 0.3620 |
| boolq          | 0.8801 | 0.8801 |
| arc_easy       | 0.8573 | 0.8548 |
| arc_challenge  | 0.6067 | 0.6084 |
| gsm8k 5 shots  | 0.7953 | 0.7908 |





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