Create README.md

README.md

@@ -0,0 +1,66 @@
+---
+base_model:
+- tencent/WeDLM-8B-Instruct
+pipeline_tag: text-generation
+---
+
+## Model Details
+
+This model is an int4 model with group_size 128 and symmetric quantization of [tencent/WeDLM-8B-Instruct](https://huggingface.co/tencent/WeDLM-8B-Instruct) generated by [intel/auto-round](https://github.com/intel/auto-round). Please follow the license of the original model.
+
+## How to Use
+
+### HF Usage
+
+```python
+# transformers==4.57.1
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+MODEL_PATH = "Intel/WeDLM-8B-Instruct-int4-AutoRound"
+
+tokenizer = AutoTokenizer.from_pretrained(MODEL_PATH, trust_remote_code=True)
+model = AutoModelForCausalLM.from_pretrained(
+    MODEL_PATH,
+    trust_remote_code=True,
+    torch_dtype="auto",
+    device_map="auto"
+)
+
+messages = [{"role": "user", "content": "Hello!"}]
+model_inputs = tokenizer.apply_chat_template(messages, return_tensors="pt", add_generation_prompt=True).to("cuda")
+generated_ids = model.generate(model_inputs, max_new_tokens=100, generation_config=model.generation_config)
+response = tokenizer.batch_decode(generated_ids)[0]
+
+print(response)
+```
+
+## Generate the Model
+
+```bash
+pip install transformers==4.57.1
+auto-round --bits 4 --iters 200 --model_name tencent/WeDLM-8B-Instruct
+```
+
+## 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](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)