Update README.md

README.md

@@ -1,3 +1,83 @@
 ---
 license: gpl-3.0
+tags:
+- text2text-generation
+pipeline_tag: text2text-generation
+language:
+- zh
+- en
 ---
+
+Considering LLaMA's license constraints, the model is for research and learning only. 
+Please strictly respect LLaMA's usage policy. We are not allowed to publish weights for LLaMA, of course, even finetuned, but there is no problem publishing the difference, a patch that we suggest to apply to the files. 
+The encryption is a simple XOR between files, ensuring that only the people that have access to the original weights (from completely legal sources, of course) can transform them into finetuned weights. 
+You can find the decrypt code on https://github.com/LianjiaTech/BELLE/tree/main/models .
+
+
+# Model Card for BELLE-LLaMA-7B-2M-q4
+
+## Welcome
+4-bit quantized version using [llama.cpp](https://github.com/ggerganov/llama.cpp) of [BELLE-LLaMA-7B-2M](https://huggingface.co/BelleGroup/BELLE-LLaMA-7B-2M-enc)
+If you find this model helpful, please *like* this model and star us on https://github.com/LianjiaTech/BELLE !
+
+
+## Model description
+BELLE-LLAMA-7B-2M-enc is based on LLAMA 7B and finetuned with 2M Chinese data combined with 50,000 pieces of English data from the open source Stanford-Alpaca, resulting in good Chinese instruction understanding and response generation capabilities. 
+
+The code of Chinese data generation and other detailed information can be found in our Github project repository: https://github.com/LianjiaTech/BELLE.
+
+
+## Download
+Should you accept our license and acknowledged the limitations, download the model by clicking [Download](https://huggingface.co/BelleGroup/BELLE-LLaMA-7B-2M-q4/resolve/main/belle-model.bin).
+
+
+## Model Usage
+This is a quantized version made for offline on-devices inferencing.
+You can use this model with ChatBELLE, a minimal, cross-platform LLM chat app powered by [BELLE](https://github.com/LianjiaTech/BELLE) 
+using quantized on-device offline models and Flutter UI, running on macOS (done), Windows, Android, 
+iOS(see [Known Issues](#known-issues)) and more.
+
+### macOS
+* Download and put the app anywhere, preferably in `Applications` folder.
+* Open the app by right click then Ctrl-click `Open`, then click `Open`.
+* The app will prompt the intended model file path and fail to load the model. Close the app.
+* Download quantized model from [BELLE-LLaMA-7B-2M-q4](https://huggingface.co/BelleGroup/BELLE-LLaMA-7B-2M-q4/blob/main/belle-model.bin).
+* Move and rename the model to the path prompted by the app. Defaults to `~/Library/Containers/com.barius.chatbelle/Data/belle-model.bin` .
+* Reopen the app again (double clicking is now OK).
+
+### Windows
+* Stay tuned
+
+### Android
+* Stay tuned
+
+### iOS
+* Stay tuned
+
+
+## Limitations
+There still exists a few issues in the model trained on current base model and data:
+
+1. The model might generate factual errors when asked to follow instructions related to facts.
+
+2. Occasionally generates harmful responses since the model still struggles to identify potential harmful instructions.
+
+3. Needs improvements on reasoning and coding.
+
+Since the model still has its limitations, we require developers only use the open-sourced code, data, model and any other artifacts generated via this project for research purposes. Commercial use and other potential harmful use cases are not allowed.
+
+
+## Citation
+
+Please cite us when using our code, data or model.
+
+```
+@misc{BELLE,
+  author = {Yunjie Ji, Yong Deng, Yan Gong, Yiping Peng, Qiang Niu, Baochang Ma, Xiangang Li},
+  title = {BELLE: Be Everyone's Large Language model Engine},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/LianjiaTech/BELLE}},
+}
+```