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 — это конвейер обработки данных от Microsoft. Он с помощью LLM извлекает структурированные знания из ваших неструктурированных текстовых документов, строит на их основе граф знаний и использует этот граф как целевой контекст, чтобы LLM точнее отвечала на вопросы о ваших закрытых данных.
Это готовое приложение-чатбот или то, что я запускаю на своих документах?Это конвейер обработки данных и набор инструментов для преобразования, работающий через командную строку, а не приложение с интерфейсом. Вы указываете ему свой текст, он индексирует его в граф, а затем вы делаете запросы к этому индексу.
Как начать работу?Сопровождающие рекомендуют пройти быстрый старт в командной строке из документации. Там описано, как установить пакет и выполнить команды индексирования и запросов.
Нужен ли мне провайдер LLM, чтобы это запустить?Да, для извлечения данных и выполнения запросов конвейеру нужна LLM (в темах репозитория упоминаются GPT/GPT-4), а также среда Python для запуска CLI.
Проект всё ещё активно развивается и дёшево ли индексирование?По обоим пунктам нет: проект перешёл в режим поддержки, поэтому Microsoft выпускает только исправления ошибок и патчи CVE, а не новые функции или пул-реквесты. Кроме того, там предупреждают, что построение графа может быть дорогой операцией, к которой нужно подходить осторожно и начинать с малого.
Это официально поддерживаемый продукт Microsoft?Нет: в README прямо сказано, что это демонстрация исследовательской методологии, а не официально поддерживаемый продукт Microsoft.
Нужно ли что-то настраивать, чтобы получать хорошие ответы?Да, сопровождающие настоятельно рекомендуют следовать руководству по настройке промптов (Prompt Tuning Guide) из документации, так как стандартные промпты могут давать не лучшие результаты на ваших данных сразу после установки.
Что нужно сделать при обновлении между версиями GraphRAG?Между минорными версиями запускайте 'graphrag init --root [path] --force', чтобы обновить формат конфигурации. При переходе на мажорные версии используйте прилагаемый блокнот миграции, чтобы не пришлось заново индексировать данные с нуля.
Creator
microsoft
Size
203.9 MB
Stars
36.4K
Age
2y
Commits · 90 Days