Knowhere 项目下载及安装教程

1. 项目介绍

Knowhere 是一个开源的向量搜索引擎，集成了 FAISS、HNSW 等技术。它是一个独立的 C++ 项目，主要作为 Milvus 的内部核心组件使用。Knowhere 旨在提供高效的向量搜索功能，适用于各种需要高性能向量搜索的应用场景。

2. 项目下载位置

Knowhere 项目的源代码托管在 GitHub 上。你可以通过以下命令克隆项目到本地：

git clone https://github.com/milvus-io/knowhere.git

3. 项目安装环境配置

系统要求

Knowhere 支持多种操作系统，包括但不限于：

• Ubuntu 20.04 x86_64
• Ubuntu 20.04 Aarch64
• MacOS (x86_64)
• MacOS (Apple Silicon)

依赖安装

在安装 Knowhere 之前，你需要确保系统中已经安装了以下依赖：

sudo apt install build-essential libopenblas-dev libaio-dev python3-dev python3-pip
pip3 install conan==1.59.0 --user
export PATH=$PATH:$HOME/.local/bin

环境配置示例

以下是一个简单的环境配置示例：

4. 项目安装方式

从源代码构建

1. 创建并进入构建目录：

   mkdir build && cd build
   

2. 使用 Conan 安装依赖并构建项目：

   # DEBUG CPU
   conan install .. --build=missing -o with_ut=True -s compiler.libcxx=libstdc++11 -s build_type=Debug
   
   # RELEASE CPU
   conan install .. --build=missing -o with_ut=True -s compiler.libcxx=libstdc++11 -s build_type=Release
   
   # DEBUG GPU
   conan install .. --build=missing -o with_ut=True -o with_raft=True -s compiler.libcxx=libstdc++11 -s build_type=Debug
   
   # RELEASE GPU
   conan install .. --build=missing -o with_ut=True -o with_raft=True -s compiler.libcxx=libstdc++11 -s build_type=Release
   
   # DISKANN SUPPORT
   conan install .. --build=missing -o with_ut=True -o with_diskann=True -s compiler.libcxx=libstdc++11 -s build_type=Debug/Release
   
   # 使用 Conan 构建项目
   conan build ..
   

运行单元测试

在构建目录中运行单元测试：

# Debug
./Debug/tests/ut/knowhere_tests

# Release
./Release/tests/ut/knowhere_tests

5. 项目处理脚本

生成 Python 轮子文件

1. 安装依赖：

   sudo apt install swig python3-dev
   

2. 构建 Knowhere 后，进入 Python 目录并生成轮子文件：

   cd python
   python3 setup.py bdist_wheel
   

3. 安装生成的轮子文件：

   pip3 install dist/knowhere-1.0.0-cp38-cp38-linux_x86_64.whl
   

清理

清理构建目录和生成的文件：

cd python
rm -rf build dist knowhere.egg-info
rm knowhere/knowhere_wrap.cpp knowhere/swigknowhere.py

通过以上步骤，你可以成功下载、安装并运行 Knowhere 项目。