Update README.md

README.md

@@ -1,3 +1,82 @@
 ---
 license: openrail
+
+datasets:
+- LinkSoul/Chinese-LLaVA-Vision-Instructions
+language:
+- zh
+- en
 ---
+
+
+# Chinese LLaVA
+
+开源，可商用的**中英文双语视觉-语言助手 Chinese-LLaVA 以及中英文视觉 SFT 数据集 Chinese-LLaVA-Vision-Instructions**，支持中英文视觉-文本多模态对话的开源可商用对话模型。
+
+<!--
+<p align="center">
+    <img src="meta/preview.jpg" width="40%">
+</p>
+-->
+
+## 基础演示
+
+![Base Demo](meta/demo.gif)
+
+## 在线试玩
+
+> Talk is cheap, Show you the Demo.
+- [Demo 地址 / HuggingFace Spaces](https://huggingface.co/spaces/LinkSoul/Chinese-LLaVA) 
+
+## 资源下载
+
+- 模型：
+  - [Chinese-LLaVA-Chinese-Llama-2-7B](https://huggingface.co/LinkSoul/Chinese-LLaVA-Cllama2)
+  - [Chinese-LLaVA-Baichuan-7B](https://huggingface.co/LinkSoul/Chinese-LLaVA-Baichuan)
+
+- 数据集：[Chinese-LLaVA-Vision-Instructions](https://huggingface.co/datasets/LinkSoul/Chinese-LLaVA-Vision-Instructions)
+
+## 环境安装
+```shell
+# clone the repository
+git clone https://github.com/LinkSoul-AI/Chinese-LLaVA
+cd Chinese-LLaVA
+
+# install package
+conda create -n Cllava python=3.10 -y
+conda activate Cllava
+pip install --upgrade pip
+pip install -e .
+```
+
+## 快速测试
+
+```shell
+python infer.py \
+    --model-name PATH/TO/THE/CHINESE_LLAVA_MODEL \
+    --llm-type "Chinese_llama2" or "baichuan" \
+    --image-file PATH/TO/THE/INPUT/IMAGE \
+    --query QUERY/PROMPT
+```
+
+## TODO
+- 如何训练
+- int4 量化
+- docker 部署
+
+## 相关项目
+
+- [LLaVA](https://llava-vl.github.io/)
+- [Chinese-Llama-2-7B](https://huggingface.co/LinkSoul/Chinese-Llama-2-7b)
+- [baichuan-inc/Baichuan-7B](https://huggingface.co/baichuan-inc/Baichuan-7B)
+
+
+## 项目协议
+
+[Apache-2.0 license](https://github.com/LinkSoul-AI/Chinese-LLaVA/blob/main/LICENSE)
+
+## 微信交流群
+<!--
+<img src=".github/QRcode.jpg" alt="微信交流群" width="300"/>
+-->
+欢迎加入[微信群](meta/QRcode.jpg)