Skip to content

Commit d3dd44c

Browse files
committed
fix: readme
1 parent 8e18831 commit d3dd44c

File tree

6 files changed

+112
-22
lines changed

6 files changed

+112
-22
lines changed

README.md

+54-3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
</div>
1818

19+
If you like this project, please leave a Star ⭐️ for it. Or you can buy the author a cup of coffee => [Support the author](./public/imgs/aw.jpg) ❤️!
20+
1921
## Overview
2022

2123
Easy Dataset is a specialized application designed to streamline the creation of fine-tuning datasets for Large Language Models (LLMs). It offers an intuitive interface for uploading domain-specific files, intelligently splitting content, generating questions, and producing high-quality training data for model fine-tuning.
@@ -37,13 +39,58 @@ With Easy Dataset, you can transform your domain knowledge into structured datas
3739

3840
## Getting Started
3941

40-
### Prerequisites
42+
### Download Client
43+
44+
<table style="width: 400px">
45+
<tr>
46+
<td width="25%" align="center">
47+
<b>Windows</b>
48+
</td>
49+
<td width="25%" align="center" colspan="2">
50+
<b>MacOS</b>
51+
</td>
52+
<td width="25%" align="center">
53+
<b>Linux</b>
54+
</td>
55+
</tr>
56+
<tr style="text-align: center">
57+
<td align="center" valign="middle">
58+
<a href='https://github.com/ConardLi/easy-dataset/releases/latest'>
59+
<img src='./public/imgs/windows.png' style="height:24px; width: 24px" />
60+
<br />
61+
<b>Setup.exe</b>
62+
</a>
63+
</td>
64+
<td align="center" valign="middle">
65+
<a href='https://github.com/ConardLi/easy-dataset/releases/latest'>
66+
<img src='./public/imgs/mac.png' style="height:24px; width: 24px" />
67+
<br />
68+
<b>Intel</b>
69+
</a>
70+
</td>
71+
<td align="center" valign="middle">
72+
<a href='https://github.com/ConardLi/easy-dataset/releases/latest'>
73+
<img src='./public/imgs/mac.png' style="height:24px; width: 24px" />
74+
<br />
75+
<b>M</b>
76+
</a>
77+
</td>
78+
<td align="center" valign="middle">
79+
<a href='https://github.com/ConardLi/easy-dataset/releases/latest'>
80+
<img src='./public/imgs/linux.png' style="height:24px; width: 24px" />
81+
<br />
82+
<b>AppImage</b>
83+
</a>
84+
</td>
85+
</tr>
86+
</table>
4187

42-
- Node.js 18.x or higher
43-
- pnpm (recommended) or npm
4488

4589
### Using npm
4690

91+
- Node.js 18.x or higher
92+
- pnpm (recommended) or npm
93+
4794
1. Clone the repository:
4895
```bash
4996
git clone https://github.com/ConardLi/easy-dataset.git
@@ -228,6 +275,10 @@ Please make sure to update tests as appropriate and adhere to the existing codin
228275

229276
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
230277

278+
## Star History
279+
280+
[![Star History Chart](https://api.star-history.com/svg?repos=ConardLi/easy-dataset&type=Date)](https://www.star-history.com/#ConardLi/easy-dataset&Date)
281+
231282

232283
<div align="center">
233284
<sub>Built with ❤️ by <a href="https://github.com/ConardLi">ConardLi</a> • Follow me:<a href="https://mp.weixin.qq.com/s/ac9XWvVsaXpSH1HH2x4TRQ">WeChat</a>|<a href="https://space.bilibili.com/474921808">Bilibili</a>|<a href="https://juejin.cn/user/3949101466785709">Juijin</a>|<a href="https://www.zhihu.com/people/wen-ti-chao-ji-duo-de-xiao-qi">Zhihu</a></sub>

README.zh-CN.md

+58-19
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616

1717
</div>
1818

19+
20+
如果喜欢本项目,请给本项目留下 Star⭐️,或者请作者喝杯咖啡呀 => [打赏作者](./public/imgs/aw.jpg) ❤️!
21+
1922
## 概述
2023

2124
Easy Dataset 是一个专为创建大型语言模型(LLM)微调数据集而设计的应用程序。它提供了直观的界面,用于上传特定领域的文件,智能分割内容,生成问题,并为模型微调生成高质量的训练数据。
@@ -37,6 +40,55 @@ Easy Dataset 是一个专为创建大型语言模型(LLM)微调数据集而
3740

3841
## 本地运行
3942

43+
### 下载客户端
44+
45+
<table style="width: 100%">
46+
<tr>
47+
<td width="25%" align="center">
48+
<b>Windows</b>
49+
</td>
50+
<td width="25%" align="center" colspan="2">
51+
<b>MacOS</b>
52+
</td>
53+
<td width="25%" align="center">
54+
<b>Linux</b>
55+
</td>
56+
</tr>
57+
<tr style="text-align: center">
58+
<td align="center" valign="middle">
59+
<a href='https://github.com/ConardLi/easy-dataset/releases/latest'>
60+
<img src='./public/imgs/windows.png' style="height:24px; width: 24px" />
61+
<br />
62+
<b>Setup.exe</b>
63+
</a>
64+
</td>
65+
<td align="center" valign="middle">
66+
<a href='https://github.com/ConardLi/easy-dataset/releases/latest'>
67+
<img src='./public/imgs/mac.png' style="height:24px; width: 24px" />
68+
<br />
69+
<b>Intel</b>
70+
</a>
71+
</td>
72+
<td align="center" valign="middle">
73+
<a href='https://github.com/ConardLi/easy-dataset/releases/latest'>
74+
<img src='./public/imgs/mac.png' style="height:24px; width: 24px" />
75+
<br />
76+
<b>M</b>
77+
</a>
78+
</td>
79+
<td align="center" valign="middle">
80+
<a href='https://github.com/ConardLi/easy-dataset/releases/latest'>
81+
<img src='./public/imgs/linux.png' style="height:24px; width: 24px" />
82+
<br />
83+
<b>AppImage</b>
84+
</a>
85+
</td>
86+
</tr>
87+
</table>
88+
89+
90+
91+
4092
### 使用 NPM 安装
4193

4294
1. 克隆仓库:
@@ -65,25 +117,7 @@ Easy Dataset 是一个专为创建大型语言模型(LLM)微调数据集而
65117

66118
4. 打开浏览器并访问 `http://localhost:3000`
67119

68-
### 使用 Docker
69-
70-
1. 拉取镜像:
71-
72-
73-
```bash
74-
docker pull conardli17/easy-dataset:latest
75-
```
76-
77-
2. 运行容器:
78-
79-
80-
```bash
81-
docker run -d -p 3000:3000 -v {YOUR_LOCAL_DB_PATH}:/app/local-db --name easy-dataset conardli17/easy-dataset:latest
82-
```
83-
84-
> 注意:为了防止数据丢失,YOUR_LOCAL_DB_PATH 应替换为你希望存储本地数据库的路径。
85120

86-
3. 打开浏览器并访问 `http://localhost:3000`
87121

88122
## 使用方法
89123

@@ -209,7 +243,8 @@ easy-dataset/
209243

210244
## 文档
211245

212-
有关所有功能和 API 的详细文档,请访问我们的[文档站点](https://github.com/ConardLi/easy-dataset/wiki)
246+
- 查看本项目的演示视频:[Easy Dataset 演示视频](https://www.bilibili.com/video/BV1y8QpYGE57/)
247+
- 有关所有功能和 API 的详细文档,请访问我们的[文档站点](https://github.com/ConardLi/easy-dataset/wiki)
213248

214249
## 贡献
215250

@@ -228,6 +263,10 @@ easy-dataset/
228263

229264
本项目采用 Apache License 2.0 许可证 - 有关详细信息,请参阅 [LICENSE](LICENSE) 文件。
230265

266+
## Star History
267+
268+
[![Star History Chart](https://api.star-history.com/svg?repos=ConardLi/easy-dataset&type=Date)](https://www.star-history.com/#ConardLi/easy-dataset&Date)
269+
231270
<div align="center">
232271
<sub>由 <a href="https://github.com/ConardLi">ConardLi</a> 用 ❤️ 构建 • 关注我:<a href="https://mp.weixin.qq.com/s/ac9XWvVsaXpSH1HH2x4TRQ">公众号</a>|<a href="https://space.bilibili.com/474921808">B站</a>|<a href="https://juejin.cn/user/3949101466785709">掘金</a>|<a href="https://www.zhihu.com/people/wen-ti-chao-ji-duo-de-xiao-qi">知乎</a></sub>
233272
</div>

public/imgs/aw.jpg

33.7 KB
Loading

public/imgs/linux.png

49.8 KB
Loading

public/imgs/mac.png

5.64 KB
Loading

public/imgs/windows.png

5.9 KB
Loading

0 commit comments

Comments
 (0)