graphrag-accelerator - GitLite

KO | EN

gitlite — search

#python #ruby #artificial-intelligence #redis #pdf #video #cloud-native #codex #data-science #containers

graphrag-accelerator

(★ 2,409)

One-click deploy of a Knowledge Graph powered RAG (GraphRAG) in Azure

File Explorer

ZIP Download

- azure-pipeline.yaml
- devcontainer.json
- Dockerfile
- entrypoint.sh
- - bug_report.md
  - feature_request.md
- - dev.yaml
  - tests.yaml
- CODEOWNERS
- dependabot.yml
- - __init__.py
  - main.py
- - cronjob.yaml
  - job.yaml
- - indexer.py
  - job-scheduler.py
  - settings.yaml
- - __init__.py
  - conftest.py
- .coveragerc
- poetry.lock
- pyproject.toml
- pytest.ini
- README.md
- Dockerfile-backend
- Dockerfile-frontend
- - graphrag-architecture-diagram.png
  - graphrag-architecture-diagram.vsdx
- DEPLOYMENT-GUIDE.md
- DEVELOPMENT-GUIDE.md
- - config.toml
- - __init__.py
  - enums.py
  - functions.py
  - graphrag_api.py
- app.py
- deploy.sh
- frontend_deploy.parameters.json
- poetry.lock
- pyproject.toml
- README.md
- style.css
- - README.md
- - createUiDefinition.json
  - mainTemplate.json
  - README.md
  - viewDefinition.json
- abbreviations.json
- deploy.parameters.json
- deploy.sh
- main.bicep
- 1-Quickstart.ipynb
- 2-Advanced_Getting_Started.ipynb
- get-wiki-articles.py
- README.md
.dockerignore
.editorconfig
.gitattributes
.gitignore
.pre-commit-config.yaml
.secrets.baseline
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
openapi.json
README.md
SECURITY.md
TRANSPARENCY.md

# Installation Guide

python

Prerequisites

Python 3.10+
Poetry latest
Docker latest
Azure CLI latest

Setup Steps

cd backend && poetry install

Install backend Python dependencies

cd frontend && poetry install

Install frontend Python dependencies

cd infra && ./deploy.sh

Deploy Azure infrastructure

Key Commands

poetry install

Install project dependencies based on pyproject.toml.

poetry run uvicorn graphrag_app.main:app --reload

Run the backend FastAPI server locally.

poetry run streamlit run app.py

Run the frontend Streamlit app locally.

poetry run pytest

Run backend tests.

GraphRAG Accelerator uses Azure services and may incur substantial costs. Please refer to the deployment guide for details.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Release Timeline

2024-09-20 v0.3.3
2024-07-02 v0.1.1

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## ⚠️ ATTENTION
This repository is no longer maintained. We sincerely appreciate the interest and all contributors to the Graphrag Solution Accelerator.

🚀 Future development and updates - Please visit the [graphrag library](https://github.com/microsoft/graphrag) for future updates and continued collaboration with the graphrag community at Microsoft.

---

[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Azure-Samples/graphrag-accelerator)

Welcome to the GraphRAG solution accelerator! This accelerator builds on top of the [graphrag](https://github.com/microsoft/graphrag) python package and exposes API endpoints hosted on Azure, which can be used to trigger indexing pipelines and enable querying of the graphrag knowledge graph.

This repository presents a methodology for running a hosted service 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: The GraphRAG Accelerator uses multiple Azure services and may incur substantial costs. It is meant to host a high-utilization API with auto-scaling and user access control. Please see the [deployment bicep](infra/main.bicep) for further detail on the services used.

⚠️ Warning: GraphRAG indexing can be an expensive operation. Please read all documentation to understand the process and costs involved, and start with a small amount of data.

For FAQ and our roadmap, please visit `aka.ms/graphrag`

![](https://raw.githubusercontent.com/Azure-Samples/graphrag-accelerator/main/docs/assets/graphrag-architecture-diagram.png)

## Getting Started with GraphRAG on Azure

### Deployment Guide
To deploy the solution accelerator, see the [deployment guide](docs/DEPLOYMENT-GUIDE.md). This will result in a full deployment of graphrag as an API.
Afterwards, check out the [Quickstart](notebooks/1-Quickstart.ipynb) notebook for a demonstration of various API calls.

## Development Guide
Interested in contributing? Check out the [development guide](docs/DEVELOPMENT-GUIDE.md).

### How to file issues and get help
This project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new Issue.

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
and actually do, grant us the rights to use your contribution. For details, visit
https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

# 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.