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)

gpt-4
Searching Database…

36.4K ·GitHub
What is this?GraphRAG is Microsoft's data pipeline that extracts structured knowledge from your unstructured text documents using LLMs, builds a knowledge graph from it, and uses that graph as targeted context so an LLM can answer questions about your private data more accurately.
Is this a ready-made chatbot app, or something I run against my own documents?It's a command-line data pipeline and transformation suite, not an app with a UI: you point it at your own text, it indexes it into a graph, and you query that index afterward.
How do I get started with it?The maintainers recommend following the command-line quickstart in the docs, which walks through installing the package and running the indexing/query commands.
Do I need an LLM provider to run it?Yes, the pipeline depends on an LLM (the repo's topics reference GPT/GPT-4) to do the extraction and querying, plus a Python environment to run the CLI.
Is this actively being developed, and is indexing cheap?No on both counts: the project is now in maintenance mode, so Microsoft is only shipping bug fixes and CVE patches rather than new features or PRs, and it also warns that graph indexing can be an expensive operation you should approach carefully and start small with.
Is this an officially supported Microsoft product?No - the README explicitly calls it a research methodology demonstration, not an officially supported Microsoft offering.
Do I need to tune anything to get good answers?Yes, the maintainers strongly recommend following the Prompt Tuning Guide in the docs, since the default prompts may not give the best results on your specific data out of the box.
What do I need to do when upgrading between GraphRAG versions?Run 'graphrag init --root [path] --force' between minor version bumps to refresh the config format, and use the provided migration notebook for major version bumps to avoid having to re-index your data from scratch.
Creator
microsoft
Size
203.9 MB
Stars
36.4K
Age
2y
Commits · 90 Days