最先进的多语言问答研究与开发的首选资源库。

PrimeQA是一个公开的开源代码库，使研究人员和开发者能够训练用于问答（QA）的最先进模型。通过使用PrimeQA，研究人员可以复现最新自然语言处理会议论文中描述的实验，同时还可以从在线存储库下载预训练模型，并在自己的自定义数据上运行这些模型。PrimeQA基于Transformers工具包构建，并使用可直接下载的数据集和模型。

PrimeQA中的模型支持端到端的问答任务。PrimeQA通过以下方式回答问题：

• 信息检索：使用传统方法（如BM25）和神经网络模型（如ColBERT）检索文档和段落。
• 多语言机器阅读理解：根据源文档或段落提取或生成答案。
• 多语言问题生成：支持为有效的领域适应生成问题，适用于表格和多语言文本。
• 检索增强生成：利用GPT-3/ChatGPT预训练模型，在检索到的段落基础上生成答案。

一些支持的模型示例（适用于基准数据集）包括：

• 传统的BM25信息检索 Pyserini
• 基于ColBERT、DPR的神经网络信息检索（与斯坦福NLP合作，由Chris Potts和Matei Zaharia领导的信息检索团队）。 复现了Dr. Decr（Li等人，2022年）为登上XOR TyDI排行榜榜首所进行的实验。
• 基于XLM-R的机器阅读理解：复现登上TyDI排行榜榜首的实验，性能与IBM GAAMA系统相似。不久将提供复现GAAMA在Natural Questions数据集上表现的代码。

🏅 排行榜榜首

PrimeQA位于多个排行榜的榜首：XOR-TyDi、TyDiQA-main、OTT-QA和HybridQA。

XOR-TyDi

TyDiQA-main

OTT-QA

HybridQA

✔️ 开始使用

安装

安装文档

# 进入项目根目录

# 如果要在GPU上运行，请确保正确安装PyTorch

# 例如，对于PyTorch 1.11 + CUDA 11.3：
pip install 'torch~=1.11.0' --extra-index-url https://download.pytorch.org/whl/cu113

# 使用pip以可编辑（-e）或不可编辑的方式安装，并根据需要添加额外组件（如测试）
# 示例安装命令：

# 最小化安装（不可编辑）
pip install .

# GPU支持
pip install .[gpu]

# 完整安装（可编辑）
pip install -e .[all]

请注意，依赖项（在setup.py中指定）已被固定版本锁定，以提供稳定的使用体验。从源代码安装时可以修改这些依赖项，但官方并不支持这种做法。

注意： 在许多环境中，基于conda-forge的faiss库比使用pip安装的默认库性能要好得多。要从conda-forge安装faiss库，请按照以下步骤操作：

• 创建并激活一个conda环境
• 使用以下命令安装faiss库：

conda install -c conda-forge faiss=1.7.0 faiss-gpu=1.7.0

• 在setup.py中移除与faiss相关的行：

"faiss-cpu~=1.7.2": ["install", "gpu"],
"faiss-gpu~=1.7.2": ["gpu"],

• 继续按照上述说明执行pip install命令。

JAVA要求

BM25检索需要Java 11。请按以下步骤安装Java：

conda install -c conda-forge openjdk=11

:speech_balloon: 博客文章

开源社区成员撰写了多篇博客文章，介绍了他们如何使用PrimeQA来满足自身需求。请阅读其中几篇：

1. PrimeQA与GPT 3
2. 使用PrimeQA进行企业搜索
3. 面向Trivia迷的搜索引擎

🧪 单元测试

测试文档

要运行单元测试，您首先需要安装PrimeQA。请务必使用pip安装时包含[tests]或[all]附加组件。

之后，您可以使用pytest运行测试，例如：

pytest --cov PrimeQA --cov-config .coveragerc tests/

更多信息，请参阅：

• 我们的tox.ini
• pytest和tox的文档

🔭 了解更多

片段	描述
📒 文档	完整的 API 文档和教程
🏁 快速入门：PrimeQA 的入口点	PrimeQA 的不同入口点：信息检索、阅读理解、表格问答和问题生成
📓 教程：Jupyter 笔记本	用于开始 QA 任务的笔记本
📓 GPT-3/ChatGPT 阅读器笔记本	用于开始使用 GPT-3/ChatGPT 阅读器组件的笔记本
💻 示例：在各种 QA 任务上应用 PrimeQA	用于在一系列 QA 任务上微调 PrimeQA 模型的示例脚本
🤗 模型分享与上传	将您微调后的模型上传并与社区共享
✅ 拉取请求	PrimeQA 拉取请求
📄 生成文档	文档的工作原理
🛠 编排服务 REST 微服务	PrimeQA 编排微服务的概念验证代码
📖 工具 UI	演示 UI

❤️ PrimeQA 合作伙伴包括

	斯坦福 NLP		伊利诺伊大学
	斯图加特大学		圣母大学
	俄亥俄州立大学		卡内基梅隆大学
	马萨诸塞大学		IBM 研究

PrimeQA 快速上手指南

PrimeQA 是一个开源的多语言问答（QA）研究与开发平台，基于 Hugging Face Transformers 构建。它支持端到端的问答流程，包括信息检索（IR）、机器阅读理解（MRC）、多语言问题生成以及检索增强生成（RAG）。

1. 环境准备

在开始之前，请确保您的系统满足以下要求：

• 操作系统: Linux 或 macOS (Windows 需通过 WSL2 运行)
• Python: 推荐 Python 3.8+
• Java: 若需使用 BM25 传统检索功能，必须安装 Java 11。
• GPU (可选): 若需加速训练或推理，请确保已安装适配的 CUDA 驱动。

前置依赖安装

安装 Java 11 (BM25 检索必需):

conda install -c conda-forge openjdk=11

优化 Faiss 性能 (强烈推荐): 为了获得比默认 pip 包更好的性能，建议使用 conda-forge 安装 Faiss：

# 创建并激活 conda 环境
conda create -n primeqa python=3.8
conda activate primeqa

# 安装 faiss 库
conda install -c conda-forge faiss=1.7.0 faiss-gpu=1.7.0

注意：如果您通过 conda 安装了 faiss，请在后续执行 pip install 前，编辑项目根目录下的 setup.py 文件，移除其中关于 faiss-cpu 和 faiss-gpu 的依赖行，以避免冲突。

2. 安装步骤

克隆仓库并进入项目根目录：

git clone https://github.com/primeqa/primeqa.git
cd primeqa

根据您的硬件环境选择以下一种安装方式：

方案 A：最小化安装 (仅 CPU)

pip install .

方案 B：GPU 支持安装 首先确保安装了正确的 PyTorch 版本（例如 torch 1.11 + CUDA 11.3）：

pip install 'torch~=1.11.0' --extra-index-url https://download.pytorch.org/whl/cu113

然后安装 PrimeQA GPU 版本：

pip install .[gpu]

方案 C：完整开发环境安装 (可编辑模式) 包含测试工具和所有额外依赖：

pip install -e .[all]

国内加速提示：如果 pip 下载速度较慢，建议添加国内镜像源，例如： pip install -i https://pypi.tuna.tsinghua.edu.cn/simple .[gpu]

3. 基本使用

PrimeQA 提供了多种入口点，包括信息检索、阅读理解和表格问答等。以下是最基础的模型加载与使用示例（基于 Hugging Face Transformers 接口）。

示例：加载预训练模型进行推理

您可以直接从 Hugging Face Hub 下载 PrimeQA 托管的预训练模型。以下示例展示如何加载一个多语言阅读理解模型：

from transformers import AutoTokenizer, AutoModelForQuestionAnswering
import torch

# 1. 指定模型名称 (例如：TyDiQA 主任务模型)
model_name = "ibm/tydiqa-primary-task-xlm-roberta-large"

# 2. 加载分词器和模型
tokenizer = AutoTokenizer.from_pretrained(model_name)
model = AutoModelForQuestionAnswering.from_pretrained(model_name)

# 3. 准备输入数据
context = "PrimeQA is an open source repository for question answering research."
question = "What is PrimeQA?"

inputs = tokenizer(question, context, return_tensors="pt")

# 4. 执行推理
with torch.no_grad():
    outputs = model(**inputs)

# 5. 解析答案
answer_start_index = torch.argmax(outputs.start_logits)
answer_end_index = torch.argmax(outputs.end_logits) + 1

predict_answer_tokens = inputs.input_ids[0, answer_start_index:answer_end_index]
answer = tokenizer.decode(predict_answer_tokens)

print(f"问题：{question}")
print(f"答案：{answer}")

进阶使用提示

• 信息检索 (IR): 查看 primeqa/ir 目录，支持 BM25 (Pyserini) 和神经检索 (ColBERT, DPR)。
• 检索增强生成 (RAG): 参考 notebooks/retriever-reader-pipelines/ 中的 Notebook，了解如何结合 GPT-3/ChatGPT 与检索到的段落生成答案。
• 微调训练: 查看 examples 目录下的脚本，学习如何在自定义数据集上微调 PrimeQA 模型。

更多详细教程和 API 文档请访问 PrimeQA 官方文档。