Vicinity项目安装与配置指南

Vicinity项目安装与配置指南

vicinity Lightweight Nearest Neighbors with Flexible Backends 项目地址: https://gitcode.com/gh_mirrors/vicin/vicinity

1. 项目基础介绍

Vicinity 是一个轻量级的向量存储库，它提供了一个简单直观的界面用于最近邻搜索，并支持多种后端和评估功能。该项目主要用于向量相似度搜索，可以帮助用户在多种索引方法和距离度量中进行选择，以找到最适合自己用例的方案。

主要编程语言：Python

2. 关键技术和框架

• 后端支持：Vicinity 支持多种后端，包括但不限于 Basic、HNSW、USEARCH、ANNOY、PYNNDESCENT、FAISS 和 VOYAGER。
• 相似度度量：支持多种相似度度量方法，如余弦相似度、欧氏距离等。
• 序列化：支持向量存储的保存和加载，以便持久化。
• HuggingFace Hub 集成：支持直接将向量存储推送到 HuggingFace Hub 或从其加载。
• 性能评估：提供了简单的性能评估方法，可以测量每秒查询次数和召回率。

3. 安装和配置

准备工作

在开始安装之前，请确保您的系统中已经安装了以下依赖：

• Python 3.6 或更高版本
• pip（Python 包管理器）

安装步骤

安装基础包

首先，通过 pip 命令安装 Vicinity 的基础包：

pip install vicinity

安装所有后端和集成

如果需要使用所有后端和集成功能，可以安装完整版的 Vicinity：

pip install vicinity[all]

配置项目

安装完成后，您可以根据需要配置不同的后端参数。以下是一个简单的配置示例：

from vicinity import Vicinity, Backend, Metric

# 初始化 Vicinity 实例，使用基础后端和余弦度量
vicinity = Vicinity.from_vectors_and_items(
    vectors=np.random.rand(10, 128),  # 生成示例向量
    items=["item1", "item2", "item3"],  # 示例项目
    backend_type=Backend.BASIC,
    metric=metric.COSINE
)

在配置后端时，可以根据项目文档中提供的参数进行详细配置，例如：

# 配置 ANNOY 后端
vicinity = Vicinity.from_vectors_and_items(
    vectors=np.random.rand(10, 128),
    items=["item1", "item2", "item3"],
    backend_type=Backend.ANNOY,
    metric=metric.COSINE,
    trees=50  # ANNOY 的树的数量
)

保存和加载向量存储

使用 Vicinity 提供的 save 和 load 方法，可以轻松保存和加载向量存储：

vicinity.save('my_vector_store')  # 保存向量存储
vicinity = Vicinity.load('my_vector_store')  # 加载向量存储

以上步骤涵盖了 Vicinity 的基础安装和配置，您可以按照实际需求进行相应的调整。

vicinity Lightweight Nearest Neighbors with Flexible Backends 项目地址: https://gitcode.com/gh_mirrors/vicin/vicinity