OpenSearch-SQL 使用教程

OpenSearch-SQL 使用教程

1. 项目目录结构及介绍

OpenSearch-SQL 项目的主要目录结构如下：

• run/：包含启动和运行项目的脚本文件。
• src/：源代码目录，包含项目的核心逻辑。
  • database_manager.py：数据库管理模块，用于处理数据库相关操作。
  • generate_question.py：生成问题的脚本，用于创建训练数据。
  • 其他文件和子目录：根据具体功能进行划分。
• .gitignore：Git 忽略文件，用于指定 Git 忽略的文件和目录。
• LICENSE：项目许可证文件，本项目采用 MIT 许可证。
• readme.md：项目说明文件，包含项目信息和基本使用方法。
• readme_zh.md：项目说明文件的中文版。
• requirements.txt：项目依赖文件，列出项目所需的 Python 包。

2. 项目的启动文件介绍

项目的启动主要通过 run/ 目录下的脚本进行：

• run_preprocess.sh：预处理脚本，用于处理数据并进行预处理操作。
• run_main.sh：主启动脚本，用于启动项目的主要逻辑。

使用以下命令运行预处理脚本：

sh run/run_preprocess.sh

使用以下命令运行主启动脚本：

sh run/run_main.sh

3. 项目的配置文件介绍

项目的配置主要通过 src/runner/database_manager.py 文件进行设置。在该文件中，可以找到 _set_paths 函数，用于设置项目的路径配置。

此外，项目使用 requirements.txt 文件管理依赖。在使用前，需要确保安装了所有列出的 Python 包。可以使用以下命令安装依赖：

pip install -r requirements.txt

以上是 OpenSearch-SQL 项目的基本使用教程，按照以上步骤操作，可以顺利启动和运行项目。