A modular graph-based Retrieval-Augmented Generation (RAG) system
Go to file
Nathan Evans 98cabba38b
Notebook tests (#978)
* Fix notebook test runs

* Delete old issue template

* Add notebook CI action

* Print temp directories

* Print more env

* Move printing up

* Use runner_temp

* Try using current directory

* Try TMP env

* Re-write TMP

* Wrong yml

* Fix echo

* Only export if windows

* More logging

* Move export

* Reformat env write

* Fix braces

* Switch to in-memory execution

* Downgrade action perms

* Unused import
2024-08-20 17:19:37 -06:00
.github Notebook tests (#978) 2024-08-20 17:19:37 -06:00
.semversioner Index API (#953) 2024-08-20 15:42:20 -06:00
.vscode Initial Release 2024-07-01 15:25:30 -06:00
docsite Add streaming support for local/global search (#944) 2024-08-20 13:44:48 -06:00
examples Modify the URL comment to make it correct. (#482) 2024-07-11 16:19:54 -06:00
examples_notebooks Docs updates aug06 (#852) 2024-08-06 16:31:47 -07:00
graphrag Index API (#953) 2024-08-20 15:42:20 -06:00
scripts Index API (#953) 2024-08-20 15:42:20 -06:00
tests Notebook tests (#978) 2024-08-20 17:19:37 -06:00
.gitignore Fix/feat: Implementation of Minute-Based Rate Limiting in CommunityReportsExtractor Using asyncio and async_mode (#373) 2024-07-05 13:41:11 -06:00
.vsts-ci.yml Initial Release 2024-07-01 15:25:30 -06:00
CHANGELOG.md Release v0.3.0 (#912) 2024-08-12 18:14:52 -06:00
CODE_OF_CONDUCT.md Initial Release 2024-07-01 15:25:30 -06:00
CODEOWNERS Stabilize smoke tests for query community context building (#908) 2024-08-12 13:17:40 -06:00
CONTRIBUTING.md Initial Release 2024-07-01 15:25:30 -06:00
cspell.config.yaml Initial Release 2024-07-01 15:25:30 -06:00
DEVELOPING.md Initial Release 2024-07-01 15:25:30 -06:00
dictionary.txt Fix default entity extraction prompt (#781) 2024-07-30 15:41:10 -06:00
LICENSE Initial Release 2024-07-01 15:25:30 -06:00
poetry.lock Bump uvloop from 0.19.0 to 0.20.0 (#969) 2024-08-20 16:18:45 -06:00
pyproject.toml Notebook tests (#978) 2024-08-20 17:19:37 -06:00
RAI_TRANSPARENCY.md Initial Release 2024-07-01 15:25:30 -06:00
README.md Docs updates aug06 (#852) 2024-08-06 16:31:47 -07:00
SECURITY.md Initial Release 2024-07-01 15:25:30 -06:00
SUPPORT.md Initial Release 2024-07-01 15:25:30 -06:00

GraphRAG

👉 Use the GraphRAG Accelerator solution
👉 Microsoft Research Blog Post
👉 Read the docs
👉 GraphRAG Arxiv

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 Solution Accelerator package. This provides a user-friendly end-to-end experience with Azure resources.

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.

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