SimplyRetrieve 使用与启动教程

SimplyRetrieve 使用与启动教程

SimplyRetrieve Lightweight chat AI platform featuring custom knowledge, open-source LLMs, prompt-engineering, retrieval analysis. Highly customizable. For Retrieval-Centric & Retrieval-Augmented Generation. 项目地址: https://gitcode.com/gh_mirrors/si/SimplyRetrieve

1. 项目目录结构及介绍

SimplyRetrieve 项目目录结构如下：

 SimplyRetrieve/
 ├── chat/
 │   ├── data/
 │   ├── docs/
 │   ├── examples/
 │   ├── gui/
 │   ├── prepare.py
 │   └── chat.py
 ├── CITATION.cff
 ├── LICENSE
 ├── README.md
 ├── requirements.txt
 └── configs/
     └── default_release.json

• chat/: 包含项目的主要执行文件和数据处理脚本。
  • data/: 存储用于检索的知识源文档。
  • docs/: 包含 GUI 操作手册和 API 访问手册。
  • examples/: 提供了 API 使用示例脚本。
  • gui/: 存储与图形界面相关的文件。
  • prepare.py: 数据准备脚本，用于处理和索引文档。
  • chat.py: 项目的主执行文件，用于启动聊天界面。
• CITATION.cff: 项目的引用文件。
• LICENSE: 项目使用的 MIT 许可证文件。
• README.md: 项目说明文件。
• requirements.txt: 项目依赖的 Python 包列表。
• configs/: 包含项目的配置文件。
  • default_release.json: 默认的配置文件。

2. 项目的启动文件介绍

项目的启动文件为 chat.py。该文件负责初始化聊天界面，并加载配置文件来启动服务。

启动命令如下：

CUDA_VISIBLE_DEVICES=0 python chat.py --config configs/default_release.json

执行上述命令后，项目会启动一个本地服务器，并可以通过浏览器访问。

3. 项目的配置文件介绍

项目的配置文件位于 configs/ 目录下，默认的配置文件为 default_release.json。

配置文件包含以下内容：

{
  "model": {
    "llm": "Wizard-Vicuna-13B-Uncensored",
    "retriever": "multilingual-e5-base"
  },
  "data": {
    "path": "chat/data/"
  },
  "gui": {
    "port": 7860
  }
}

配置文件定义了以下参数：

• model: 指定了使用的语言模型（LLM）和检索器（retriever）的名称。
• data: 指定了知识源文档的存储路径。
• gui: 指定了图形界面的端口。

根据需要，用户可以修改配置文件中的参数来适应不同的使用场景。

注意：以上内容使用 markdown 格式编写，且不包含任何链接。

SimplyRetrieve Lightweight chat AI platform featuring custom knowledge, open-source LLMs, prompt-engineering, retrieval analysis. Highly customizable. For Retrieval-Centric & Retrieval-Augmented Generation. 项目地址: https://gitcode.com/gh_mirrors/si/SimplyRetrieve