🤝 贡献

我们欢迎社区贡献，以帮助增强 GraphRAG Local Ollama！请参阅我们的贡献指南，了解更多关于如何参与的信息。

需要支持 llama 集成。

🚀 GraphRAG Local Ollama - 知识图谱

欢迎来到 GraphRAG Local Ollama！这个仓库是对微软的 GraphRAG 的一次激动人心的改编，专门用于支持通过 Ollama 下载的本地模型。告别昂贵的 OpenAPI 模型，迎接使用 Ollama 进行高效、经济实惠的本地推理吧！

📄 研究论文

有关 GraphRAG 实现的更多详细信息，请参阅 GraphRAG 论文。

论文摘要

利用检索增强生成（RAG）从外部知识源中检索相关信息，可以使大型语言模型（LLM）对私有和/或此前未见过的文档集合进行问答。然而，RAG 对于针对整个文本语料库的全局性问题却难以胜任，例如“数据集中有哪些主要主题？”这类问题，因为这本质上是一个查询聚焦的摘要任务（QFS），而非明确的检索任务。与此同时，现有的 QFS 方法又无法扩展到典型 RAG 系统所索引的文本数量级别。为了结合这两种截然不同的方法的优势，我们提出了一种基于图的 RAG 方法，用于对私有文本语料库进行问答，该方法既能适应用户问题的普遍性，又能处理待索引的海量源文本。我们的方法利用 LLM 分两步构建基于图的文本索引：首先从源文档中提取实体知识图，然后为所有紧密相关的实体群组预先生成社区摘要。给定一个问题时，每个社区摘要都会被用来生成部分响应，随后所有部分响应会被再次汇总成最终的用户响应。对于一类涉及百万级标记数据集的全局性理解问题，我们证明 GraphRAG 在生成答案的全面性和多样性方面都显著优于朴素的 RAG 基线。

🌟 特性

• 本地模型支持： 使用 Ollama 提供的本地模型进行 LLM 和嵌入计算。
• 经济高效： 摆脱对昂贵 OpenAPI 模型的依赖。
• 易于设置： 设置过程简单直接。

📦 安装与设置

按照以下步骤设置此仓库，并使用 Ollama 提供的本地模型运行 GraphRag：

1. 创建并激活一个新的 conda 环境：（请务必使用指定的 Python 3.10 版本，以免出现错误）

   conda create -n graphrag-ollama-local python=3.10
   conda activate graphrag-ollama-local
   

2. 安装 Ollama：

   • 请访问 Ollama 官网 获取安装说明。
   • 或者运行：

   curl -fsSL https://ollama.com/install.sh | sh #适用于 Linux 的 Ollama
   pip install ollama
   

3. 使用 Ollama 下载所需模型，我们可以选择（mistral、gemma2、qwen2）作为 LLM，以及 Ollama 提供的任何嵌入模型：

   ollama pull mistral  # LLM
   ollama pull nomic-embed-text  # 嵌入模型
   

4. 克隆仓库：

   git clone https://github.com/TheAiSingularity/graphrag-local-ollama.git
   

5. 进入仓库目录：

   cd graphrag-local-ollama/
   

6. 安装 graphrag 包 这是最重要的一步：

   pip install -e .
   

7. 创建所需的输入目录：这里将存储实验数据和结果——./ragtest

   mkdir -p ./ragtest/input
   

8. 将示例数据文件夹 input/ 复制到 ./ragtest。input/ 包含用于运行设置的示例数据。您可以在此处添加自己的 .txt 格式数据。

   cp input/* ./ragtest/input
   

9. 初始化 ./ragtest 文件夹以创建所需文件：

   python -m graphrag.index --init --root ./ragtest
   

10. 移动 settings.yaml 文件，这是配置了 Ollama 本地模型的主预定义配置文件：

    cp settings.yaml ./ragtest
    

用户可以通过更改模型来进行实验。LLM 模块期望使用 llama3、mistral、phi3 等语言模型，而嵌入模块则期望使用 mxbai-embed-large、nomic-embed-text 等由 Ollama 提供的嵌入模型。您可以在 https://ollama.com/library 找到 Ollama 提供的完整模型列表，这些模型都可以在本地部署。默认的 API 基础 URL 分别为 LLM 的 http://localhost:11434/v1 和嵌入的 http://localhost:11434/api，因此已将其添加到相应部分。

11. 运行索引，这将创建一个图：

    python -m graphrag.index --root ./ragtest
    

12. 运行查询：仅支持全局方法

    python -m graphrag.query --root ./ragtest --method global "什么是机器学习？"
    

图可以保存下来，之后可通过将 settings.yaml 中的 graphml 设置为 “true” 来进行可视化：

snapshots:
graphml: true

要可视化生成的 graphml 文件，您可以使用：https://gephi.org/users/download/ 或仓库中提供的脚本 visualize-graphml.py：

在 visualize-graphml.py 中，将 .graphml 文件路径传递给以下行：

graph = nx.read_graphml('output/20240708-161630/artifacts/summarized_graph.graphml')

13. 可视化 .graphml：

    python visualize-graphml.py
    

引用

• 微软原版 GraphRAG 仓库：GraphRAG
• Ollama：Ollama

---

按照上述步骤，您可以设置并使用 GraphRAG 的本地模型，从而使流程更加经济高效。

GraphRAG Local Ollama 快速上手指南

本指南帮助中国开发者在本地使用 Ollama 运行 Microsoft GraphRAG，实现低成本、高效率的知识图谱构建与全局问答。

环境准备

• 操作系统：Linux / macOS / Windows (WSL2 推荐)
• Python 版本：严格使用 Python 3.10（其他版本可能导致兼容性问题）
• 依赖工具：
  • Conda（推荐用于环境管理）
  • Ollama（本地大模型运行时）
• 网络要求：需能访问 Hugging Face 或 Ollama 模型库（国内用户可配置镜像加速）

💡 国内用户建议：

• 使用清华/中科大 PyPI 镜像：pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
• Ollama 模型下载若缓慢，可尝试手动下载模型文件后导入（参考 Ollama 官方文档）

安装步骤

1. 创建并激活 Conda 环境

conda create -n graphrag-ollama-local python=3.10
conda activate graphrag-ollama-local

2. 安装 Ollama

curl -fsSL https://ollama.com/install.sh | sh
pip install ollama

Windows 用户请前往 https://ollama.com/download 下载安装包手动安装。

3. 拉取所需本地模型

ollama pull mistral          # LLM 模型（可选：llama3, qwen2, phi3 等）
ollama pull nomic-embed-text # 嵌入模型（可选：mxbai-embed-large 等）

4. 克隆项目仓库

git clone https://github.com/TheAiSingularity/graphrag-local-ollama.git
cd graphrag-local-ollama/

5. 安装 GraphRAG 包

pip install -e .

6. 准备数据目录

mkdir -p ./ragtest/input
cp input/* ./ragtest/input   # 复制示例数据，也可替换为自己的 .txt 文件

7. 初始化配置

python -m graphrag.index --init --root ./ragtest
cp settings.yaml ./ragtest   # 覆盖为预配置的 Ollama 本地模型设置

✅ settings.yaml 已默认配置：

• LLM API: http://localhost:11434/v1
• Embedding API: http://localhost:11434/api 如需更换模型，编辑该文件中对应字段即可。

基本使用

1. 构建知识图谱索引

python -m graphrag.index --root ./ragtest

首次运行将自动抽取实体、构建图谱、生成社区摘要。耗时取决于数据量和模型性能。

2. 执行全局问答查询

python -m graphrag.query --root ./ragtest --method global "什么是机器学习？"

当前仅支持 global 方法，适用于对整体数据集进行主题归纳与宏观洞察。

3. （可选）可视化知识图谱 编辑 ./ragtest/settings.yaml，启用 GraphML 输出：

snapshots:
  graphml: true

重新运行索引后，使用内置脚本可视化：

python visualize-graphml.py

或使用 Gephi 打开生成的 .graphml 文件进行高级可视化分析。

---

完成以上步骤，你已成功在本地部署基于 Ollama 的 GraphRAG 系统，无需依赖付费 API，即可体验强大的图谱增强检索能力。