|
| 1 | +# GraphRAG |
| 2 | + |
| 3 | +👉 [Microsoft Research Blog Post](https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/)<br/> |
| 4 | +👉 [Read the docs](https://microsoft.github.io/graphrag)<br/> |
| 5 | +👉 [GraphRAG Arxiv](https://arxiv.org/pdf/2404.16130) |
| 6 | + |
| 7 | +<div align="left"> |
| 8 | + <a href="https://pypi.org/project/graphrag/"> |
| 9 | + <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/graphrag"> |
| 10 | + </a> |
| 11 | + <a href="https://pypi.org/project/graphrag/"> |
| 12 | + <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/graphrag"> |
| 13 | + </a> |
| 14 | + <a href="https://github.com/microsoft/graphrag/issues"> |
| 15 | + <img alt="GitHub Issues" src="https://img.shields.io/github/issues/microsoft/graphrag"> |
| 16 | + </a> |
| 17 | + <a href="https://github.com/microsoft/graphrag/discussions"> |
| 18 | + <img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/microsoft/graphrag"> |
| 19 | + </a> |
| 20 | +</div> |
| 21 | + |
| 22 | +## Overview |
| 23 | + |
| 24 | +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. |
| 25 | + |
| 26 | +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 <a href="https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/" target="_blank">Microsoft Research Blog Post.</a> |
| 27 | + |
| 28 | +## Quickstart |
| 29 | + |
| 30 | +To get started with the GraphRAG system we recommend trying the [command line quickstart](https://microsoft.github.io/graphrag/get_started/). |
| 31 | + |
| 32 | +## Repository Guidance |
| 33 | + |
| 34 | +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. |
| 35 | + |
| 36 | +⚠️ *Warning: GraphRAG indexing can be an expensive operation, please read all of the documentation to understand the process and costs involved, and start small.* |
| 37 | + |
| 38 | +## Diving Deeper |
| 39 | + |
| 40 | +- To learn about our contribution guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md) |
| 41 | +- To start developing _GraphRAG_, see [DEVELOPING.md](./DEVELOPING.md) |
| 42 | +- Join the conversation and provide feedback in the [GitHub Discussions tab!](https://github.com/microsoft/graphrag/discussions) |
| 43 | + |
| 44 | +## Prompt Tuning |
| 45 | + |
| 46 | +Using _GraphRAG_ with your data out of the box may not yield the best possible results. |
| 47 | +We strongly recommend to fine-tune your prompts following the [Prompt Tuning Guide](https://microsoft.github.io/graphrag/prompt_tuning/overview/) in our documentation. |
| 48 | + |
| 49 | +## Versioning |
| 50 | + |
| 51 | +Please see the [breaking changes](./breaking-changes.md) document for notes on our approach to versioning the project. |
| 52 | + |
| 53 | +*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 backup if necessary.* |
| 54 | + |
| 55 | +## Responsible AI FAQ |
| 56 | + |
| 57 | +See [RAI_TRANSPARENCY.md](./RAI_TRANSPARENCY.md) |
| 58 | + |
| 59 | +- [What is GraphRAG?](./RAI_TRANSPARENCY.md#what-is-graphrag) |
| 60 | +- [What can GraphRAG do?](./RAI_TRANSPARENCY.md#what-can-graphrag-do) |
| 61 | +- [What are GraphRAG’s intended use(s)?](./RAI_TRANSPARENCY.md#what-are-graphrags-intended-uses) |
| 62 | +- [How was GraphRAG evaluated? What metrics are used to measure performance?](./RAI_TRANSPARENCY.md#how-was-graphrag-evaluated-what-metrics-are-used-to-measure-performance) |
| 63 | +- [What are the limitations of GraphRAG? How can users minimize the impact of GraphRAG’s limitations when using the system?](./RAI_TRANSPARENCY.md#what-are-the-limitations-of-graphrag-how-can-users-minimize-the-impact-of-graphrags-limitations-when-using-the-system) |
| 64 | +- [What operational factors and settings allow for effective and responsible use of GraphRAG?](./RAI_TRANSPARENCY.md#what-operational-factors-and-settings-allow-for-effective-and-responsible-use-of-graphrag) |
| 65 | + |
| 66 | +## Trademarks |
| 67 | + |
| 68 | +This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft |
| 69 | +trademarks or logos is subject to and must follow |
| 70 | +[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). |
| 71 | +Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. |
| 72 | +Any use of third-party trademarks or logos are subject to those third-party's policies. |
| 73 | + |
| 74 | +## Privacy |
| 75 | + |
| 76 | +[Microsoft Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement) |
0 commit comments