Update README.md

README.md

@@ -1,4 +1,67 @@
 ---
 base_model:
 - deepseek-ai/DeepSeek-V3.1
----
+pipeline_tag: text-generation
+---
+
+## Model Details
+
+This model is an mixed int4 model with group_size 128 and symmetric quantization of [deepseek-ai/DeepSeek-V3.1](https://huggingface.co/deepseek-ai/DeepSeek-V3.1) generated by [intel/auto-round](https://github.com/intel/auto-round) **via RTN(no algorithm tuning)**. 
+Non expert layers are fallback to 8 bits. Please refer to Section Generate the model for more details.
+Please follow the license of the original model.
+
+## How To Use
+
+
+
+### Generate the model
+
+This pr is required if the model is fp8 and the device supports fp8  https://github.com/intel/auto-round/pull/750
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import transformers
+from auto_round import AutoRound
+
+model_name = "deepseek-ai/DeepSeek-V3.1-Base"
+
+layer_config = {}
+for n, m in model.named_modules():
+    if isinstance(m, torch.nn.Linear):
+        if "expert" in n and "shared_experts" not in n:
+            layer_config[n] = {"bits": 4}
+            print(n, 4)
+        elif n != "lm_head":
+            layer_config[n] = {"bits": 8}
+            print(n, 8)
+
+autoround = AutoRound(model_name, iters=0, layer_config=layer_config)
+autoround.quantize_and_save(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)
+
+## 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)