axa / graphRAG /README.md
Mayara Ayat
Upload folder using huggingface_hub
f7ab812 verified

A newer version of the Gradio SDK is available: 5.25.0

Upgrade

GraphRAG

GraphRAG is a Python-based framework designed to build, manage, and query Graph Retrieval-Augmented Generation (GraphRAG) systems. It combines advanced graph processing tools like Neo4j and NetworkX with natural language capabilities powered by LLMs (Large Language Models) to create, visualize, and query knowledge graphs.


Features

  • Knowledge Graph Construction: Extract entities and relationships from text and construct a knowledge graph.
  • Graph Management:
    • Store and query graphs in Neo4j.
    • Perform analysis and operations on NetworkX graphs.
  • Graph Summarization: Analyze and summarize communities within the graph.
  • Natural Language Interaction: Generate answers to queries using the knowledge graph and language models.
  • Interactive Visualization: Explore and interact with knowledge graphs using Gradio.
  • Modular Design: A highly organized and reusable codebase for scalable development.

File Structure

β”œβ”€β”€ graphRAG # Main project directory

β”œβ”€β”€ init.py #Marks the directory as a Python package 

β”œβ”€β”€ main.py # Entry point to run the GraphRAG pipeline 

β”œβ”€β”€ community_summaries.pkl # Serialized summaries of graph communities 

β”œβ”€β”€ entities_extraction.py # Extract entities and relationships from text 

β”œβ”€β”€ generating_answers.py # Generate answers to queries using the graph 

β”œβ”€β”€ get_communities.py # Identify and analyze graph communities 

β”œβ”€β”€ gradio_viz.py # Gradio-based interactive graph visualization 

β”œβ”€β”€ graph_builder.py # Build the knowledge graph 

β”œβ”€β”€ graph_nx.py # Manage and analyze NetworkX-based graphs 

β”œβ”€β”€ KG_classes.py # Defines classes for knowledge graph objects 

β”œβ”€β”€ subgraphs.py # Extract and manage subgraphs 

β”œβ”€β”€ utils.py # Shared utility functions 

β”œβ”€β”€ graph.gpickle # Serialized NetworkX graph file 

β”œβ”€β”€ README.md # Project documentation (this file)