提交 7aae5b45 作者: imClumsyPanda

update README.md

上级 264981e4
...@@ -98,25 +98,33 @@ $ python webui.py ...@@ -98,25 +98,33 @@ $ python webui.py
```shell ```shell
$ python api.py $ python api.py
``` ```
或执行 cd views 或执行以下脚本体验基于 VUE 的前端页面
```shell
pnpm i $ cd views
npm run dev $ pnpm i
体验vue页面 $ npm run dev
```
注:如未将模型下载至本地,请执行前检查`$HOME/.cache/huggingface/`文件夹剩余空间,至少15G。 注:如未将模型下载至本地,请执行前检查`$HOME/.cache/huggingface/`文件夹剩余空间,至少15G。
执行后效果如下图所示: 执行后效果如下图所示:
![webui](img/webui_0419.png) 1. `对话` Tab 界面
![](img/webui_0510_0.png)
2. `知识库测试 Beta` Tab 界面
![](img/webui_0510_1.png)
3. `模型配置` Tab 界面
![](img/webui_0510_2.png)
Web UI 可以实现如下功能: Web UI 可以实现如下功能:
1. 运行前自动读取`configs/model_config.py``LLM``Embedding`模型枚举及默认模型设置运行模型,如需重新加载模型,可在 `模型配置` 标签页重新选择后点击 `重新加载模型` 进行模型加载; 1. 运行前自动读取`configs/model_config.py``LLM``Embedding`模型枚举及默认模型设置运行模型,如需重新加载模型,可在 `模型配置` Tab 重新选择后点击 `重新加载模型` 进行模型加载;
2. 可手动调节保留对话历史长度、匹配知识库文段数量,可根据显存大小自行调节; 2. 可手动调节保留对话历史长度、匹配知识库文段数量,可根据显存大小自行调节;
3. 具备模式选择功能,可选择 `LLM对话``知识库问答` 模式进行对话,支持流式对话; 3. `对话` Tab 具备模式选择功能,可选择 `LLM对话``知识库问答` 模式进行对话,支持流式对话;
4. 添加 `配置知识库` 功能,支持选择已有知识库或新建知识库,并可向知识库中**新增**上传文件/文件夹,使用文件上传组件选择好文件后点击 `上传文件并加载知识库`,会将所选上传文档数据加载至知识库中,并基于更新后知识库进行问答; 4. 添加 `配置知识库` 功能,支持选择已有知识库或新建知识库,并可向知识库中**新增**上传文件/文件夹,使用文件上传组件选择好文件后点击 `上传文件并加载知识库`,会将所选上传文档数据加载至知识库中,并基于更新后知识库进行问答;
5. 后续版本中将会增加对知识库的修改或删除,及知识库中已导入文件的查看。 5. 新增 `知识库测试 Beta` Tab,可用于测试不同文本切分方法与检索相关度阈值设置,暂不支持将测试参数作为 `对话` Tab 设置参数。
6. 后续版本中将会增加对知识库的修改或删除,及知识库中已导入文件的查看。
### 常见问题 ### 常见问题
......
...@@ -121,7 +121,13 @@ $ python api.py ...@@ -121,7 +121,13 @@ $ python api.py
Note: Before executing, check the remaining space in the `$HOME/.cache/huggingface/` folder, at least 15G. Note: Before executing, check the remaining space in the `$HOME/.cache/huggingface/` folder, at least 15G.
The resulting interface is shown below: The resulting interface is shown below:
![webui](img/webui_0419.png)
![](img/webui_0510_0.png)
![](img/webui_0510_1.png)
![](img/webui_0510_2.png)
The Web UI supports the following features: The Web UI supports the following features:
1. Automatically reads the `LLM` and `embedding` model enumerations in `configs/model_config.py`, allowing you to select and reload the model by clicking `重新加载模型`. 1. Automatically reads the `LLM` and `embedding` model enumerations in `configs/model_config.py`, allowing you to select and reload the model by clicking `重新加载模型`.
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论