graphrag README

The project's README from github.com/microsoft/graphrag. As one markdown file: README.md.

GraphRAG

[!WARNING] GraphRAG is a research project that explores the functional use of graphs to form a targeted context for question answering. Since our first release in July 2024 the capabilities of frontier models have changed dramatically, and our portfolio of research projects has diversified to match. This project is largely in maintenance mode, and won't be accepting new PRs or implementing new features. We'll perform bug fixes and dependency updates as appropriate, particularly to address CVEs as they arise.

👉 Microsoft Research Blog Post
👉 Read the docs
👉 GraphRAG Arxiv

PyPI - Version PyPI - Downloads GitHub Issues GitHub Discussions

Overview

The GraphRAG project is a data pipeline and transformation suite that is designed to extract meaningful, structured data from unstructured text using the power of LLMs.

To learn more about GraphRAG and how it can be used to enhance your LLM's ability to reason about your private data, please visit the Microsoft Research Blog Post.

Quickstart

To get started with the GraphRAG system we recommend trying the command line quickstart.

Repository Guidance

This repository presents a methodology for using knowledge graph memory structures to enhance LLM outputs. Please note that the provided code serves as a demonstration and is not an officially supported Microsoft offering.

⚠️ Warning: GraphRAG indexing can be an expensive operation, please read all of the documentation to understand the process and costs involved, and start small.

Diving Deeper

Prompt Tuning

Using GraphRAG with your data out of the box may not yield the best possible results. We strongly recommend to fine-tune your prompts following the Prompt Tuning Guide in our documentation.

Versioning

Please see the breaking changes document for notes on our approach to versioning the project.

Always run graphrag init --root [path] --force between minor version bumps to ensure you have the latest config format. Run the provided migration notebook between major version bumps if you want to avoid re-indexing prior datasets. Note that this will overwrite your configuration and prompts, so back them up if necessary.

Responsible AI FAQ

See RAI_TRANSPARENCY.md

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Privacy

Microsoft Privacy Statement

graphrag (microsoft/graphrag)

Searching Database…

36.4K ·GitHub
这是什么?GraphRAG 是微软的一个数据处理管道,它利用大语言模型(LLM)从你的非结构化文本文档中提取结构化知识,据此构建知识图谱,并将该图谱作为有针对性的上下文,使大语言模型能够更准确地回答关于你私有数据的问题。
这是现成的聊天机器人应用,还是我要用来处理自己文档的工具?它是一套命令行数据处理和转换工具,并不是带图形界面的应用:你把它指向自己的文本,它会将文本索引成图谱,之后你再查询这个索引。
我该怎么开始使用?维护者建议参考文档中的命令行快速入门,其中会介绍如何安装软件包,以及如何运行索引和查询命令。
运行它需要大语言模型服务商吗?需要。该管道依赖大语言模型(仓库的主题标签提到了 GPT/GPT-4)来完成信息提取和查询,同时还需要 Python 环境来运行命令行工具。
这个项目还在积极开发吗?建立索引便宜吗?两个问题的答案都是否定的:该项目现已进入维护模式,微软只发布错误修复和 CVE 安全补丁,不再开发新功能或接受 PR。此外,项目还提醒说,图索引可能是一项成本高昂的操作,应谨慎对待,并从小规模开始。
这是微软官方支持的产品吗?不是。README 明确说明,它是一个研究方法的演示,而不是微软官方支持的产品。
要想获得好的回答,我需要做什么调优吗?需要。维护者强烈建议参考文档中的提示词调优指南,因为默认提示词在你的具体数据上未必能直接给出最佳结果。
升级不同版本的 GraphRAG 时,我需要做什么?在小版本之间升级时,运行 'graphrag init --root [path] --force' 以刷新配置格式;在大版本升级时,使用随附的迁移笔记本,避免从头重新索引你的数据。
Creator
microsoft
Size
203.9 MB
Stars
36.4K
Age
2y
Commits · 90 Days