mirror of
https://github.com/microsoft/graphrag.git
synced 2025-11-04 03:39:55 +00:00
bcb74789f1
* Wordind updates * Update yam lconfig and add notes to "deprecated" env * Add basic search section * Update versioning docs * Minor edits for clarity * Update init command * Update init to add --force in docs * Add NLP extraction params * Move vector_store to root * Add workflows to config * Add FastGraphRAG docs * add metadata column changes * Added documentation for multi index search. * Minor fixes. * Add config and table renames * Update migration notebook and comments to specify v1 * Add frequency to entity table docs * add new chunking options for metadata * Update output docs * Minor edits and cleanup * Add model ids to search configs * Spruce up migration notebook * Lint/format multi-index notebook * SpaCy model note * Update SpaCy footnote * Updated multi_index_search.ipynb to remove ruff errors. * add spacy to dictionary --------- Co-authored-by: Alonso Guevara <alonsog@microsoft.com> Co-authored-by: Dayenne Souza <ddesouza@microsoft.com> Co-authored-by: dorbaker <dorbaker@microsoft.com>
78 lines
4.7 KiB
Markdown
78 lines
4.7 KiB
Markdown
# GraphRAG
|
||
|
||
👉 [Use the GraphRAG Accelerator solution](https://github.com/Azure-Samples/graphrag-accelerator) <br/>
|
||
👉 [Microsoft Research Blog Post](https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/)<br/>
|
||
👉 [Read the docs](https://microsoft.github.io/graphrag)<br/>
|
||
👉 [GraphRAG Arxiv](https://arxiv.org/pdf/2404.16130)
|
||
|
||
<div align="left">
|
||
<a href="https://pypi.org/project/graphrag/">
|
||
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/graphrag">
|
||
</a>
|
||
<a href="https://pypi.org/project/graphrag/">
|
||
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/graphrag">
|
||
</a>
|
||
<a href="https://github.com/microsoft/graphrag/issues">
|
||
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/microsoft/graphrag">
|
||
</a>
|
||
<a href="https://github.com/microsoft/graphrag/discussions">
|
||
<img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/microsoft/graphrag">
|
||
</a>
|
||
</div>
|
||
|
||
## 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 <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>
|
||
|
||
## Quickstart
|
||
|
||
To get started with the GraphRAG system we recommend trying the [Solution Accelerator](https://github.com/Azure-Samples/graphrag-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
|
||
|
||
- To learn about our contribution guidelines, see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
||
- To start developing _GraphRAG_, see [DEVELOPING.md](./DEVELOPING.md)
|
||
- Join the conversation and provide feedback in the [GitHub Discussions tab!](https://github.com/microsoft/graphrag/discussions)
|
||
|
||
## 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](https://microsoft.github.io/graphrag/prompt_tuning/overview/) in our documentation.
|
||
|
||
## Versioning
|
||
|
||
Please see the [breaking changes](./breaking-changes.md) 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 backup if necessary.*
|
||
|
||
## Responsible AI FAQ
|
||
|
||
See [RAI_TRANSPARENCY.md](./RAI_TRANSPARENCY.md)
|
||
|
||
- [What is GraphRAG?](./RAI_TRANSPARENCY.md#what-is-graphrag)
|
||
- [What can GraphRAG do?](./RAI_TRANSPARENCY.md#what-can-graphrag-do)
|
||
- [What are GraphRAG’s intended use(s)?](./RAI_TRANSPARENCY.md#what-are-graphrags-intended-uses)
|
||
- [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)
|
||
- [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)
|
||
- [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)
|
||
|
||
## 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](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
|
||
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](https://privacy.microsoft.com/en-us/privacystatement)
|