beir

环境要求

• Python 3.9 及以上版本（README 明确说明 Tested with python versions 3.9+）
• pip 包管理工具
• 如需使用 encode_and_retrieve() 密集检索，需额外安装 faiss-cpu
• 如需 LoRA + vLLM 示例，需额外安装 peft、accelerate、vllm
• 如需调用 Cohere 等外部 API 示例，需安装 cohere 并自备 API Key

安装与启动步骤

1. 1检查 Python 版本

   BEIR 官方仅在 Python 3.9 及以上版本测试通过，先确认本机版本满足要求，建议在虚拟环境中安装。

   python --version

   复制

2. 2pip 安装 BEIR

   最简安装方式，直接从 PyPI 拉取 beir 包，适合只想调用 API 的普通用户。

   pip install beir

   复制

3. 3源码安装（可选）

   需要改动源码或跟进最新提交时使用；-e 为可编辑安装，clone 下来的目录名即 beir。

   git clone https://github.com/beir-cellar/beir.git
   cd beir
   pip install -e .

   复制

4. 4安装 faiss 依赖（可选）

   仅在使用 encode_and_retrieve() 做密集检索时需要，README 指定安装 CPU 版 faiss。

   pip install faiss-cpu

   复制

5. 5安装 LoRA/vLLM 依赖（可选）

   README 的 LoRA & vLLM 快速示例要求先装这三个包，用于大模型检索与重排序场景。

   pip install peft
   pip install accelerate
   pip install vllm

   复制

6. 6安装 Cohere API 依赖（可选）

   调用 Cohere 等外部 API 的示例需要该 SDK，同样建议配合 faiss-cpu 使用。

   pip install cohere

   复制

7. 7查阅官方快速开始文档

   README 的代码片段被截断，未给出可直接执行的完整脚本，请按 Quick Start 链接访问官方 Wiki 获取教程。

关键配置

如何确认成功

执行 pip show beir 能看到包版本信息，或在 Python 中 import beir 不报 ModuleNotFoundError，即表示安装成功。

常见问题

注意事项

• BEIR 是 Python 库而非独立服务，安装后按需在脚本中 import 调用即可。
• 官方明确测试的 Python 版本为 3.9+，低版本可能出现兼容问题。
• faiss-cpu、peft、accelerate、vllm、cohere 均为按功能选装的可选依赖，不装也能使用基础检索评估功能。
• 本节选未提供端口、路径、模型名等具体参数，请以官方 Wiki 与 Hugging Face 页面为准。