RaBitQ 项目启动与配置教程

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

RaBitQ 项目目录结构如下：

RaBitQ/
├── bin/                        # 存放可执行文件
├── data/                       # 存放数据集和预处理脚本
├── results/                    # 存放查询结果
├── script/                     # 存放运行脚本项目
├── src/                        # 源代码目录，包括 RaBitQ 算法的实现
│   ├── ivf_rabitq.h
│   ├── space.h
│   ├── fast_scan.h
│   └── ...                     # 其他源代码文件
├── LICENSE                     # Apache-2.0 许可证文件
├── README.md                   # 项目说明文件
└── technical_report.pdf        # 项目技术报告

• bin/ 目录：存放编译后的可执行文件。
• data/ 目录：包含项目所需的数据集以及数据预处理的脚本。
• results/ 目录：用于存放查询的结果文件。
• script/ 目录：包含用于构建和运行项目的各种脚本文件。
• src/ 目录：存放 RaBitQ 算法的源代码文件。
• LICENSE 文件：Apache-2.0 许可证，说明项目的开源协议。
• README 文件：项目说明文件，介绍项目相关信息。
• technical_report.pdf 文件：项目的技术报告。

2. 项目的启动文件介绍

项目的启动主要通过 script/ 目录下的脚本进行。以下是两个主要的启动文件：

• index.sh：该脚本用于索引数据集，为 RaBitQ 算法准备数据结构。
• search.sh：该脚本用于执行查询，并将查询结果输出到 results/ 目录。

要启动项目并执行索引和查询，需要在项目根目录下运行以下命令：

./script/index.sh
./script/search.sh

3. 项目的配置文件介绍

项目的配置主要通过修改 script/ 目录下的脚本文件来实现。以下是主要的配置文件：

• 在 index.sh 和 search.sh 脚本中，你可以配置数据集的路径、查询的参数以及输出的结果文件路径等。

此外，你还需要确保在 src/ 目录中正确配置了编译选项，以及确保外部依赖（如 Eigen 库）已被正确安装并链接到项目中。

在开始编译和运行之前，请检查 README 文件中提到的所有先决条件是否都已满足，并确保所有依赖项都已正确安装。