Skip to content

Commit

Permalink
[DOC] Update README.md (#241)
Browse files Browse the repository at this point in the history
  • Loading branch information
MING-ZCH authored May 11, 2024
2 parents e4c1e5e + 9f1aa3d commit f62d487
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@
- [🎨微调指南](#微调指南)
- [🔧部署指南](#部署指南)
- [⚙RAG(检索增强生成)](#rag检索增强生成)
- [🎓评测指南](#评测指南)
- [使用到的框架](#使用到的框架)
- [如何参与本项目](#如何参与本项目)
- [作者(排名不分先后)](#作者排名不分先后)
Expand Down Expand Up @@ -207,7 +208,8 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git
- [数据构建](#数据构建)
- [微调指南](#微调指南)
- [部署指南](#部署指南)
- [RAG](#rag检索增强生成pipeline)
- [RAG](#rag检索增强生成)
- [评测指南](#评测指南)
- 查看更多详情


Expand Down Expand Up @@ -236,6 +238,10 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git

- 详见[RAG](rag/README.md)

### 🎓评测指南

- 本模型评测分为通用评测和专业评测,请阅读[评测指南](evaluate/README.md)查阅

<details>
<summary>更多详情</summary>

Expand Down
10 changes: 8 additions & 2 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ The Model aims to fully understand and promote the mental health of individuals,
- [🎨Fine-tuning Guide](#fine-tuning-guide)
- [🔧Deployment Guide](#deployment-guide)
- [⚙RAG (Retrieval Augmented Generation)](#rag-retrieval-augmented-generation)
- [🎓Evaluation Guide](#evaluation-guide)
- [Frameworks Used](#frameworks-used)
- [How to participate in this project](#how-to-participate-in-this-project)
- [Version control](#version-control)
Expand Down Expand Up @@ -208,7 +209,8 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git
- [Data Construction](#data-construction)
- [Fine-tuning Guide](#fine-tuning-guide)
- [Deployment Guide](#deployment-guide)
- [RAG](#rag-retrieval-augmented-generation-pipeline)
- [RAG](#rag-retrieval-augmented-generation)
- [Evaluation Guide](#evaluation-guide)
- View More Details


Expand All @@ -218,7 +220,7 @@ git clone https://github.com/SmartFlowAI/EmoLLM.git

### 📌Data Construction

- Please read the [Data Construction Guide ](generate_data/tutorial_EN.md)for reference.
- 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)

Expand All @@ -235,6 +237,10 @@ For details, see the [fine-tuning guide](xtuner_config/README_EN.md)

- See [RAG](rag/README_EN.md)

### 🎓Evaluation Guide

- The model evaluation is divided into **General Metrics Evaluation** and **Professional Metrics Evaluation**,Please read the [evaluation guide](evaluate/README.md) for reference.

<details>
<summary>Additional Details</summary>

Expand Down

0 comments on commit f62d487

Please sign in to comment.