HugeGraph-AI

🚀 Best practice: Prioritize using DeepWiki intelligent documents

To address the issue of outdated static documents, we provide DeepWiki with real-time updates and more comprehensive content. It is equivalent to an expert with the latest knowledge of the project, which is very suitable for all developers to read and consult before starting the project.

👉 Strongly recommend visiting and having a conversation with: incubator-hugegraph-ai

hugegraph-ai integrates HugeGraph with artificial intelligence capabilities, providing comprehensive support for developers to build AI-powered graph applications.

✨ Key Features

• GraphRAG: Build intelligent question-answering systems with graph-enhanced retrieval
• Knowledge Graph Construction: Automated graph building from text using LLMs
• Graph ML: Integration with 20+ graph learning algorithms (GCN, GAT, GraphSAGE, etc.)
• Python Client: Easy-to-use Python interface for HugeGraph operations
• AI Agents: Intelligent graph analysis and reasoning capabilities

🚀 Quick Start

[!NOTE] For a complete deployment guide and detailed examples, please refer to hugegraph-llm/README.md

Prerequisites

• Python 3.9+ (3.10+ recommended for hugegraph-llm)
• uv (recommended package manager)
• HugeGraph Server 1.3+ (1.5+ recommended)
• Docker (optional, for containerized deployment)

Option 1: Docker Deployment (Recommended)

# Clone the repository
git clone https://github.com/apache/incubator-hugegraph-ai.git
cd incubator-hugegraph-ai

# Set up environment and start services
cp docker/env.template docker/.env
# Edit docker/.env to set your PROJECT_PATH
cd docker
docker-compose -f docker-compose-network.yml up -d

# Access services:
# - HugeGraph Server: http://localhost:8080
# - RAG Service: http://localhost:8001

Option 2: Source Installation

# 1. Start HugeGraph Server
docker run -itd --name=server -p 8080:8080 hugegraph/hugegraph

# 2. Clone and set up the project
git clone https://github.com/apache/incubator-hugegraph-ai.git
cd incubator-hugegraph-ai/hugegraph-llm

# 3. Install dependencies
uv venv && source .venv/bin/activate
uv pip install -e .

# 4. Start the demo
python -m hugegraph_llm.demo.rag_demo.app
# Visit http://127.0.0.1:8001

Basic Usage Examples

GraphRAG - Question Answering

from hugegraph_llm.operators.graph_rag_task import RAGPipeline

# Initialize RAG pipeline
graph_rag = RAGPipeline()

# Ask questions about your graph
result = (graph_rag
    .extract_keywords(text="Tell me about Al Pacino.")
    .keywords_to_vid()
    .query_graphdb(max_deep=2, max_graph_items=30)
    .synthesize_answer()
    .run())

Knowledge Graph Construction

from hugegraph_llm.models.llms.init_llm import LLMs
from hugegraph_llm.operators.kg_construction_task import KgBuilder

# Build KG from text
TEXT = "Your text content here..."
builder = KgBuilder(LLMs().get_chat_llm())

(builder
    .import_schema(from_hugegraph="hugegraph")
    .chunk_split(TEXT)
    .extract_info(extract_type="property_graph")
    .commit_to_hugegraph()
    .run())

Graph Machine Learning

from pyhugegraph.client import PyHugeClient
# Connect to HugeGraph and run ML algorithms
# See hugegraph-ml documentation for detailed examples

📦 Modules

hugegraph-llm

Large language model integration for graph applications:

• GraphRAG: Retrieval-augmented generation with graph data
• Knowledge Graph Construction: Build KGs from text automatically
• Natural Language Interface: Query graphs using natural language
• AI Agents: Intelligent graph analysis and reasoning

hugegraph-ml

Graph machine learning with 20+ implemented algorithms:

• Node Classification: GCN, GAT, GraphSAGE, APPNP, etc.
• Graph Classification: DiffPool, P-GNN, etc.
• Graph Embedding: DeepWalk, Node2Vec, GRACE, etc.
• Link Prediction: SEAL, GATNE, etc.

hugegraph-python-client

Python client for HugeGraph operations:

• Schema Management: Define vertex/edge labels and properties
• CRUD Operations: Create, read, update, delete graph data
• Gremlin Queries: Execute graph traversal queries
• REST API: Complete HugeGraph REST API coverage

📚 Learn More

• Project Homepage
• LLM Quick Start Guide
• DeepWiki AI Documentation

🔗 Related Projects

• hugegraph - Core graph database
• hugegraph-toolchain - Development tools (Loader, Dashboard, etc.)
• hugegraph-computer - Graph computing system

🤝 Contributing

We welcome contributions! Please see our contribution guidelines for details.

Development Setup:

• Use GitHub Desktop for easier PR management
• Run ./style/code_format_and_analysis.sh before submitting PRs
• Check existing issues before reporting bugs

📄 License

hugegraph-ai is licensed under Apache 2.0 License.

📞 Contact Us

• GitHub Issues: Report bugs or request features (fastest response)
• Email: dev@hugegraph.apache.org (subscription required)
• WeChat: Follow “Apache HugeGraph” official account