TarsosLSH 项目教程

1. 项目目录结构及介绍

TarsosLSH 是一个实现局部敏感哈希（Locality Sensitive Hashing, LSH）的 Java 库，用于在多维向量空间中进行近似最近邻搜索。项目的目录结构如下：

TarsosLSH/
├── build/
│   ├── ANT 构建文件
├── data/
│   ├── 示例数据文件
├── lib/
│   ├── 依赖库文件
├── src/
│   ├── be/tarsos/
│       ├── lsh/
│           ├── LSH 实现源码
│       ├── mih/
│           ├── 多索引哈希实现源码
├── test/
│   ├── be/tarsos/
│       ├── 单元测试源码
├── .gitignore
├── LICENSE.txt
├── README.textile

目录介绍

• build/: 包含 ANT 构建文件，用于构建项目和生成文档。
• data/: 包含示例数据文件，用于测试和演示。
• lib/: 包含项目依赖的库文件。
• src/: 包含项目的核心源码，分为 lsh 和 mih 两个子目录，分别实现 LSH 和多索引哈希算法。
• test/: 包含单元测试源码，用于验证核心功能的正确性。
• .gitignore: Git 忽略文件配置。
• LICENSE.txt: 项目许可证文件。
• README.textile: 项目介绍和使用说明。

2. 项目启动文件介绍

TarsosLSH 项目的主要启动文件是 TarsosLSH.jar，这是一个可执行的 JAR 文件，可以通过命令行运行。启动文件的主要功能是执行 LSH 算法，查找数据集中的最近邻。

启动命令

java -jar TarsosLSH.jar [options] dataset.txt queries.txt

参数说明

• dataset.txt: 包含数据集的文件，每行表示一个向量。
• queries.txt: 包含查询向量的文件，每行表示一个查询向量。
• options: 可选参数，用于配置 LSH 算法的具体行为，例如哈希家族、哈希数量、哈希表数量等。

3. 项目配置文件介绍

TarsosLSH 项目没有传统的配置文件，其配置主要通过命令行参数进行。以下是一些常用的配置选项：

常用配置选项

• -f cos|l1|l2: 定义使用的哈希家族，可选值包括 cos（余弦距离）、l1（城市块距离）、l2（欧几里得距离）。
• -r radius: 定义查找最近邻的半径，默认为自动确定。
• -h n_hashes: 定义使用的哈希数量，默认为 4。
• -t n_tables: 定义使用的哈希表数量，默认为 4。
• -n n_neighbours: 定义查找的最近邻数量，默认为 3。

示例配置

java -jar TarsosLSH.jar -f l2 -r 500 -h 3 -t 5 dataset.txt queries.txt

以上命令使用欧几里得距离（l2），查找半径为 500，使用 3 个哈希和 5 个哈希表，查找数据集 dataset.txt 中与查询文件 queries.txt 中的向量最近的邻居。

通过这些配置选项，用户可以根据具体需求调整 LSH 算法的参数，以获得最佳的搜索性能。