[Doc] update readme
This commit is contained in:
parent
a25df2db70
commit
e97b1a86ad
11
README.md
11
README.md
@ -210,27 +210,27 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git
|
||||
- 查看更多详情
|
||||
|
||||
|
||||
### 快速体验
|
||||
### 🍪快速体验
|
||||
|
||||
- 请阅读[快速体验](docs/quick_start.md)查阅
|
||||
|
||||
|
||||
### 数据构建
|
||||
### 📌数据构建
|
||||
|
||||
- 请阅读[数据构建指南](generate_data/tutorial.md)查阅
|
||||
|
||||
- 微调用到的数据集见[datasets](datasets/data.json)
|
||||
|
||||
### 微调指南
|
||||
### 🎨微调指南
|
||||
|
||||
详见[微调指南](xtuner_config/README.md)
|
||||
|
||||
### 部署指南
|
||||
### 🔧部署指南
|
||||
|
||||
- Demo部署:详见[部署指南](demo/README.md)
|
||||
- 基于[LMDeploy](https://github.com/InternLM/lmdeploy/)的量化部署:详见[deploy](./deploy/lmdeploy.md)
|
||||
|
||||
### RAG(检索增强生成)Pipeline
|
||||
### ⚙RAG(检索增强生成)Pipeline
|
||||
|
||||
- 详见[RAG](./rag/)
|
||||
|
||||
@ -312,6 +312,7 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git
|
||||
- [闻星大佬(小助手)](https://github.com/vansin)
|
||||
- [扫地升(公众号宣传)](https://mp.weixin.qq.com/s/78lrRl2tlXEKUfElnkVx4A)
|
||||
- 阿布(北大心理学硕士)
|
||||
- [HatBoy](https://github.com/hatboy)
|
||||
|
||||
<!-- links -->
|
||||
|
||||
|
13
README_EN.md
13
README_EN.md
@ -203,29 +203,29 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git
|
||||
- [Data Construction](#data-construction)
|
||||
- [Fine-tuning Guide](#fine-tuning-guide)
|
||||
- [Deployment Guide](#deployment-guide)
|
||||
- [RAG][]
|
||||
- [RAG](#rag-retrieval-augmented-generation-pipeline)
|
||||
- View More Details
|
||||
|
||||
|
||||
### Quick start
|
||||
### 🍪Quick start
|
||||
- Please read [Quick Start](docs/quick_start_EN.md) to see.
|
||||
|
||||
### Data Construction
|
||||
### 📌Data Construction
|
||||
|
||||
- Please read the [Data Construction Guide ](generate_data/tutorial_EN.md)for reference.
|
||||
|
||||
- The dataset used for this fine-tuning can be found at [datasets](datasets/data.json)
|
||||
|
||||
### Fine-tuning Guide
|
||||
### 🎨Fine-tuning Guide
|
||||
|
||||
For details, see the [fine-tuning guide](xtuner_config/README_EN.md)
|
||||
|
||||
### Deployment Guide
|
||||
### 🔧Deployment Guide
|
||||
|
||||
- Demo deployment: see [deployment guide](./demo/README_EN.md) for details.
|
||||
- Quantitative deployment based on [LMDeploy](https://github.com/InternLM/lmdeploy/): see [deploy](./deploy/lmdeploy_EN.md)
|
||||
|
||||
### RAG (Retrieval Augmented Generation) Pipeline
|
||||
### ⚙RAG (Retrieval Augmented Generation) Pipeline
|
||||
|
||||
- See [RAG](./rag/)
|
||||
|
||||
@ -299,6 +299,7 @@ The project is licensed under the MIT License. Please refer to the details
|
||||
- [Vanin](https://github.com/vansin)
|
||||
- [Bloom up (WeChat Official Account Promotion)](https://mp.weixin.qq.com/s/78lrRl2tlXEKUfElnkVx4A)
|
||||
- Abu (M.A. in Psychology, Peking University)
|
||||
- [HatBoy](https://github.com/hatboy)
|
||||
|
||||
<!-- links -->
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user