update README.md
This commit is contained in:
parent
0f3fc5234d
commit
68e593a64a
64
README.md
64
README.md
|
|
@ -18,52 +18,6 @@
|
|||
|
||||

|
||||
|
||||
项目目录结构
|
||||
```text
|
||||
.
|
||||
├── agent
|
||||
│ └── agent实现
|
||||
├── chains
|
||||
│ ├── modules
|
||||
│ └── chains实现
|
||||
├── configs
|
||||
│ └── 系统初始化配置
|
||||
├── content
|
||||
│ └── 临时附件上传位置
|
||||
├── docs
|
||||
│ └── 项目文档
|
||||
├── fastchat
|
||||
│ ├── api
|
||||
│ └── 一个fastchat langchain的LLM远程调用拓展
|
||||
├── img
|
||||
│ └── 项目资源目录
|
||||
├── loras
|
||||
│ └── 默认的本地lora文件存放路径
|
||||
├── model
|
||||
│ └── 默认的本地checkpoint存放路径
|
||||
├── models
|
||||
│ ├── extensions
|
||||
│ │ └── LLM内部拓展包
|
||||
│ ├── loader
|
||||
│ │ └── 项目checkpoint加载器,支持chatglm(AutoModel)、量化模型(llama.cpp)、其它模型(AutoModelForCausalLM),兼容lora、ptuning_v2微调文件加载
|
||||
│ └── 实现chatglm、LLama等一些模型的langchain LLM wrapper integrations
|
||||
├── nltk_data
|
||||
│ ├── corpora
|
||||
│ │ └── cmudict
|
||||
│ ├── taggers
|
||||
│ │ └── averaged_perceptron_tagger
|
||||
│ └── tokenizers
|
||||
│ └── punkt
|
||||
├── ptuning-v2
|
||||
├── textsplitter
|
||||
│ └── 中文语义分割
|
||||
├── utils
|
||||
│ └── 系统工具
|
||||
└── vector_store
|
||||
└── faiss本地矢量库索引文件
|
||||
|
||||
|
||||
```
|
||||
|
||||
🚩 本项目未涉及微调、训练过程,但可利用微调或训练对本项目效果进行优化。
|
||||
|
||||
|
|
@ -170,9 +124,17 @@ $ pnpm i
|
|||
$ npm run dev
|
||||
```
|
||||
|
||||
执行后效果如下图所示:
|
||||
VUE 前端界面如下图所示:
|
||||
1. `对话` 界面
|
||||

|
||||
2. `知识库问答` 界面
|
||||

|
||||
3. `搜索`界面
|
||||

|
||||
|
||||
WebUI 界面如下图所示:
|
||||
1. `对话` Tab 界面
|
||||

|
||||

|
||||
2. `知识库测试 Beta` Tab 界面
|
||||

|
||||
3. `模型配置` Tab 界面
|
||||
|
|
@ -226,7 +188,8 @@ Web UI 可以实现如下功能:
|
|||
- [ ] Langchain 应用
|
||||
- [x] 接入非结构化文档(已支持 md、pdf、docx、txt 文件格式)
|
||||
- [x] jpg 与 png 格式图片的 OCR 文字识别
|
||||
- [ ] 搜索引擎与本地网页接入
|
||||
- [x] 搜索引擎接入
|
||||
- [ ] 本地网页接入
|
||||
- [ ] 结构化数据接入(如 csv、Excel、SQL 等)
|
||||
- [ ] 知识图谱/图数据库接入
|
||||
- [ ] Agent 实现
|
||||
|
|
@ -251,10 +214,11 @@ Web UI 可以实现如下功能:
|
|||
- [x] 上传文件/文件夹至知识库
|
||||
- [x] 知识库测试
|
||||
- [ ] 删除知识库中文件
|
||||
- [ ] 利用 streamlit 实现 Web UI Demo
|
||||
- [x] 支持搜索引擎问答
|
||||
- [ ] 增加 API 支持
|
||||
- [x] 利用 fastapi 实现 API 部署方式
|
||||
- [ ] 实现调用 API 的 Web UI Demo
|
||||
- [x] VUE 前端
|
||||
|
||||
## 项目交流群
|
||||

|
||||
|
|
|
|||
21
README_en.md
21
README_en.md
|
|
@ -120,9 +120,26 @@ $ python api.py
|
|||
```
|
||||
Note: Before executing, check the remaining space in the `$HOME/.cache/huggingface/` folder, at least 15G.
|
||||
|
||||
The resulting interface is shown below:
|
||||
Or execute following command to run VUE after api.py executed
|
||||
```shell
|
||||
$ cd views
|
||||
|
||||

|
||||
$ pnpm i
|
||||
|
||||
$ npm run dev
|
||||
```
|
||||
|
||||
VUE interface screenshots:
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
Web UI interface screenshots:
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 961 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.4 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 346 KiB |
Loading…
Reference in New Issue