Create README.md

README.md

@@ -0,0 +1,71 @@
+---
+tags:
+- auto-round
+license: other
+license_name: modified-mit
+library_name: transformers
+pipeline_tag: image-text-to-text
+base_model:
+- moonshotai/Kimi-K2.5
+---
+## Model Details
+
+This model is an int4 model with group_size 128 of [moonshotai/Kimi-K2.5](https://huggingface.co/moonshotai/Kimi-K2.5) generated by [intel/auto-round](https://github.com/intel/auto-round) with RTN mode. Please follow the license of the original model.
+
+
+## vllm Infernece Example
+
+~~~bash
+vllm serve INCModel/Kimi-K2.5-MXFP4-AutoRound -tp 8 --mm-encoder-tp-mode data --trust-remote-code --tool-call-parser kimi_k2 --reasoning-parser kimi_k2  --served-model-name kimi  --max-model-len 4096
+~~~
+
+~~~bash
+curl http://localhost:8000/v1/chat/completions -H "Content-Type: application/json" -d ' {
+    "model": "kimi",
+    "messages": [
+      {"role": "system", "content": "You are a helpful assistant."},
+      {"role": "user", "content": "Write code to fine-tune an LLM."}
+    ],
+    "temperature": 1,
+    "max_tokens": 2048
+  } '
+
+~~~
+
+
+## Generate the Model
+
+This pr is required https://github.com/intel/auto-round/pull/1642
+
+RTN version
+
+~~~bash
+auto-round /workspace/models/moonshotai/Kimi-K2.5  --iters 0 --disable_opt_rtn --scheme mxfp4  --format llm_compressor  --output_dir /workspace/models/moonshotai/Kimi-K2.5-MXFP4
+# the automatic saved preprocessor_config.json doesn't work, copy it.
+cp /workspace/models/moonshotai/Kimi-K2.5/preprocessor_config.json /workspace/models/moonshotai/Kimi-K2.5-MXFP4/Kimi-K2.5-mxfp-w4g32/preprocessor_config.json
+~~~
+
+
+## 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](