Update README.md

README.md

@@ -1,3 +1,97 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+datasets:
+- NeelNanda/pile-10k
+language:
+- en
+---
+
+
+## Model Details
+
+This model is an int4 model with group_size 128 of [upstage/SOLAR-10.7B-Instruct-v1.0](https://huggingface.co/upstage/SOLAR-10.7B-Instruct-v1.0)  generated by [intel/auto-round](https://github.com/intel/auto-round).
+Inference of this model is compatible with AutoGPTQ's Kernel.
+
+
+
+
+
+
+### Reproduce the model
+
+Here is the sample command to reproduce the model
+
+```bash
+git clone https://github.com/intel/auto-round
+cd auto-round/examples/language-modeling
+pip install -r requirements.txt
+python3 main.py \
+--model_name  upstage/SOLAR-10.7B-Instruct-v1.0 \
+--device 0 \
+--group_size 128 \
+--bits 4 \
+--iters 1000 \
+--n_samples 1024 \
+--train_bs 16 \
+--minmax_lr 0.01 \
+--deployment_device 'gpu' \
+--output_dir "./tmp_autoround" \
+
+```
+
+
+
+
+
+
+### Evaluate the model
+
+Install [lm-eval-harness 0.4.2](https://github.com/EleutherAI/lm-evaluation-harness.git) from source,
+
+```bash
+lm_eval --model hf --model_args pretrained="Intel/SOLAR-10.7B-Instruct-v1.0-int4-inc",autogptq=True,gptq_use_triton=True --device cuda:0 --tasks lambada_openai,hellaswag,piqa,winogrande,truthfulqa_mc1,openbookqa,boolq,arc_easy,arc_challenge,mmlu --batch_size 32
+```
+
+
+
+| Metric         | FP16   | INT4   |
+| -------------- | ------ | ------ |
+| Avg.           | 0.6891 | 0.6895 |
+| mmlu           | 0.6358 | 0.6271 |
+| lambada_openai | 0.7277 | 0.7351 |
+| hellaswag      | 0.6868 | 0.6845 |
+| winogrande     | 0.7672 | 0.7585 |
+| piqa           | 0.8069 | 0.8128 |
+| truthfulqa_mc1 | 0.5777 | 0.5692 |
+| openbookqa     | 0.3640 | 0.382 |
+| boolq          | 0.8853 | 0.8862 |
+| arc_easy       | 0.8321 | 0.8354 |
+| arc_challenge  | 0.6075 | 0.6041 |
+
+
+
+
+
+
+## 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}, journal={arXiv preprint arXiv:2309.05516}, year={2023} }
+
+[arxiv](https://arxiv.org/abs/2309.05516) [github](https://github.com/intel/auto-round)