UltraRAG 项目使用教程

1. 项目的目录结构及介绍

UltraRAG 项目是一个模块化、易于定制的 Retrieval-Augmented Generation (RAG) 系统框架。以下是项目的目录结构及其简要介绍：

UltraRAG/
├── .github/                # GitHub 相关的模板文件
├── .streamlit/             # Streamlit 相关的配置文件
├── config/                 # 配置文件目录
├── docs/                   # 文档目录
├── examples/               # 示例代码目录
├── scripts/                # 脚本目录，包括数据下载等脚本
├── ultrarag/               # UltraRAG 核心代码目录
├── Dockerfile              # Docker 配置文件
├── LICENSE.txt             # 项目许可证文件
├── README.md               # 项目说明文件
├── docker-compose.yml      # Docker Compose 配置文件
├── requirements.txt        # 项目依赖文件
└── setup.py                # 项目设置文件

• .github/：包含 GitHub Actions 工作流等 GitHub 相关配置。
• .streamlit/：Streamlit 应用程序的配置文件。
• config/：包含项目的配置文件，如模型下载列表等。
• docs/：存放项目文档。
• examples/：包含示例代码，用于展示如何使用 UltraRAG。
• scripts/：包含一些辅助脚本，例如用于下载模型和数据的脚本。
• ultrarag/：包含 UltraRAG 的核心实现代码。
• Dockerfile：用于创建 UltraRAG 的 Docker 容器。
• LICENSE.txt：Apache-2.0 许可证文本。
• README.md：项目的说明文档，通常包含项目介绍、安装和快速开始指南。
• docker-compose.yml：用于定义和运行多容器 Docker 应用程序。
• requirements.txt：列出了项目运行所需的 Python 包依赖。
• setup.py：用于构建和打包 Python 项目。

2. 项目的启动文件介绍

项目的启动主要依赖于 streamlit 工具。以下是如何启动 UltraRAG 的前端页面：

• 使用 Docker：运行以下命令后，在浏览器中访问 http://localhost:8843。

  docker-compose up --build -d
  

• 使用 Conda：首先创建并激活一个名为 ultrarag 的 conda 环境，然后安装相关依赖，并运行以下命令启动 demo 页面。

  conda create -n ultrarag python=3.10
  conda activate ultrarag
  pip install -r requirements.txt
  python scripts/download_model.py
  streamlit run ultrarag/webui/webui.py --server.fileWatcherType none
  

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，以下是其中几个重要的配置文件：

• models_download_list.yaml：列出项目所需下载的模型及其相关信息。
• 其他配置文件可能包括数据源、模型参数、评估指标等设置。

配置文件使用 YAML 格式，可以根据具体需求进行修改，以适应不同的使用场景。