cuhnsw 项目使用教程

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

cuhnsw/
├── examples/
│   ├── example1.py
│   └── README.md
├── cuhnsw/
│   ├── __init__.py
│   ├── config.proto
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
└── ...

• examples/: 包含示例代码和使用说明。
• cuhnsw/: 项目的主要代码目录。
• __init__.py: Python包的初始化文件。
• config.proto: 配置文件的协议缓冲区定义。
• .gitignore: Git忽略文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件通常是 examples/example1.py，该文件展示了如何构建和保存模型，以及如何加载模型并进行搜索。

# examples/example1.py
import h5py
from cuhnsw import CuHNSW

# 构建和保存模型
h5f = h5py.File("glove-50-angular.hdf5", "r")
data = h5f["train"][:].astype(np.float32)
h5f.close()
ch0 = CuHNSW(opt={})
ch0.set_data(data)
ch0.build()
ch0.save_index("cuhnsw_index")

# 加载模型和搜索
h5f = h5py.File("glove-50-angular.hdf5", "r")
data = h5f["train"][:].astype(np.float32)
h5f.close()
ch0 = CuHNSW(opt={})
ch0.load_index("cuhnsw_index")
results = ch0.search(query_data)

3. 项目的配置文件介绍

项目的配置文件是 cuhnsw/config.proto，该文件定义了项目的配置选项。

// cuhnsw/config.proto
syntax = "proto3";

package cuhnsw;

message Config {
    int32 max_elements = 1;
    int32 ef_construction = 2;
    int32 m = 3;
    // 其他配置选项
}

该配置文件使用 Protocol Buffers 格式定义了项目的配置选项，包括最大元素数、构造时的 ef 参数和 m 参数等。

---

以上是 cuhnsw 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！