Skip to content

Commit 44602a2

Browse files
Merge pull request #121 from TencentCloudADP/docs-vercel
docs vercel
2 parents 3c1ea34 + fe0273e commit 44602a2

134 files changed

Lines changed: 13494 additions & 9 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 59 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,78 @@
1+
# Python
12
*/__pycache__/
23
*.py[oc]
34
build/
45
dist/
56
wheels/
67
*.egg-info
7-
8-
.DS_Store
9-
.vscode
10-
.idea
11-
.codebuddy/
12-
13-
148
.venv
159
.env
1610

11+
# AI/ML files
1712
*.pt
1813
*.pkl
1914
*.npy
2015
*.index
21-
*.json
2216

17+
# Node.js & Next.js
18+
node_modules/
19+
.next/
20+
out/
21+
.cache/
22+
*.tsbuildinfo
23+
.contentlayer/
24+
.content-collections/
25+
.source/
26+
..bfg-report/
27+
28+
29+
30+
# Package manager files
31+
package-lock.json
32+
yarn-error.log*
33+
npm-debug.log*
34+
yarn-debug.log*
35+
lerna-debug.log*
36+
37+
# Environment variables
38+
.env*.local
39+
.env.development.local
40+
.env.test.local
41+
.env.production.local
42+
43+
# IDE & Editors
44+
.DS_Store
45+
.vscode/
46+
.idea/
47+
*.swp
48+
*.swo
49+
*~
50+
.codebuddy/
51+
52+
# OS files
53+
Thumbs.db
54+
Desktop.ini
55+
ehthumbs.db
56+
57+
# Temporary files
58+
.tmp/
59+
*.tmp
60+
*.temp
61+
62+
# Coverage & Testing
63+
coverage/
64+
.nyc_output/
65+
.eslintcache
66+
.stylelintcache
67+
68+
# Deployment
69+
.vercel/
70+
next-env.d.ts
71+
72+
# Project specific
73+
*.json
2374
data/
2475
output/
25-
2676
retriever/faiss_cache_new/*
2777
docker/Dockerfile
2878
site/

docs/.source/index.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// @ts-nocheck -- skip type checking
2+
import * as docs_3 from "../content/docs/zh/quick-start.mdx?collection=docs&hash=1760950978830"
3+
import * as docs_2 from "../content/docs/zh/index.mdx?collection=docs&hash=1760950978830"
4+
import * as docs_1 from "../content/docs/en/quick-start.mdx?collection=docs&hash=1760950978830"
5+
import * as docs_0 from "../content/docs/en/index.mdx?collection=docs&hash=1760950978830"
6+
import { _runtime } from "fumadocs-mdx"
7+
import * as _source from "../source.config"
8+
export const docs = _runtime.docs<typeof _source.docs>([{ info: {"path":"en/index.mdx","absolutePath":"/Users/pro/Desktop/youtu-graphrag/docs/content/docs/en/index.mdx"}, data: docs_0 }, { info: {"path":"en/quick-start.mdx","absolutePath":"/Users/pro/Desktop/youtu-graphrag/docs/content/docs/en/quick-start.mdx"}, data: docs_1 }, { info: {"path":"zh/index.mdx","absolutePath":"/Users/pro/Desktop/youtu-graphrag/docs/content/docs/zh/index.mdx"}, data: docs_2 }, { info: {"path":"zh/quick-start.mdx","absolutePath":"/Users/pro/Desktop/youtu-graphrag/docs/content/docs/zh/quick-start.mdx"}, data: docs_3 }], [{"info":{"path":"en/meta.json","absolutePath":"/Users/pro/Desktop/youtu-graphrag/docs/content/docs/en/meta.json"},"data":{"pages":["index","quick-start"],"defaultOpen":true,"icon":"home-4-line"}}, {"info":{"path":"zh/meta.json","absolutePath":"/Users/pro/Desktop/youtu-graphrag/docs/content/docs/zh/meta.json"},"data":{"pages":["index","quick-start"],"defaultOpen":true,"icon":"home-4-line"}}])

docs/.source/source.config.mjs

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// source.config.ts
2+
import {
3+
defineConfig,
4+
defineDocs,
5+
frontmatterSchema,
6+
metaSchema
7+
} from "fumadocs-mdx/config";
8+
import { z } from "zod";
9+
var docs = defineDocs({
10+
docs: {
11+
schema: frontmatterSchema.extend({
12+
author: z.string().optional(),
13+
avatar: z.string().optional(),
14+
github_username: z.string().optional(),
15+
x_username: z.string().optional(),
16+
demo_url: z.string().url().optional()
17+
})
18+
},
19+
meta: {
20+
schema: metaSchema
21+
}
22+
});
23+
var source_config_default = defineConfig({
24+
mdxOptions: {
25+
// MDX options
26+
}
27+
});
28+
export {
29+
source_config_default as default,
30+
docs
31+
};

docs/.vercel/README.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
> Why do I have a folder named ".vercel" in my project?
2+
The ".vercel" folder is created when you link a directory to a Vercel project.
3+
4+
> What does the "project.json" file contain?
5+
The "project.json" file contains:
6+
- The ID of the Vercel project that you linked ("projectId")
7+
- The ID of the user or team your Vercel project is owned by ("orgId")
8+
9+
> Should I commit the ".vercel" folder?
10+
No, you should not share the ".vercel" folder with anyone.
11+
Upon creation, it will be automatically added to your ".gitignore" file.

docs/content/docs/en/index.mdx

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
---
2+
title: Youtu-GraphRAG Introduction
3+
description: Vertically Unified Agents for Graph Retrieval-Augmented Complex Reasoning - Revolutionary framework moving Pareto Frontier with 33.6% lower token cost and 16.62% higher accuracy over SOTA baselines.
4+
sidebar_position: 1
5+
---
6+
7+
## Overview
8+
9+
**Youtu-GraphRAG** is a vertically unified agentic paradigm that jointly connects the entire framework as an intricate integration based on graph schema. We allow seamless domain transfer with minimal intervention on the graph schema, providing insights of the next evolutionary GraphRAG paradigm for real-world applications with remarkable adaptability.
10+
11+
🚀 Revolutionary framework moving Pareto Frontier with **33.6% lower token cost** and **16.62% higher accuracy** over SOTA baselines
12+
13+
## Framework Architecture
14+
15+
![](https://cdn.jsdelivr.net/gh/AllenWriter/picgo-images@main/images/20251020143857.png)
16+
17+
*A sketched overview of our proposed framework Youtu-GraphRAG.*
18+
19+
## Interactive Interface
20+
21+
This [video](https://youtu.be/fVUsgClHqwc) walks through the main features of the project.
22+
23+
![](https://cdn.jsdelivr.net/gh/AllenWriter/picgo-images@main/images/202510201506606.png)
24+
25+
![](https://cdn.jsdelivr.net/gh/AllenWriter/picgo-images@main/images/202510201506480.png)
26+
27+
28+
## When and Why to use Youtu-GraphRAG
29+
30+
🔗 **Multi-hop Reasoning/Summarization/Conclusion**: Complex questions requiring multi-step reasoning
31+
📚 **Knowledge-Intensive Tasks**: Questions dependent on large amounts of structured/private/domain knowledge
32+
🌐 **Domain Scalability**: Easily support encyclopedias, academic papers, commercial/private knowledge base and other domains with minimal intervention on the schema
33+
34+
## Core Capabilities
35+
36+
Based on our unified agentic paradigm for Graph Retrieval-Augmented Generation (GraphRAG), Youtu-GraphRAG introduces several key innovations that jointly connect the entire framework as an intricate integration:
37+
38+
### 🏗️ Schema-Guided Hierarchical Knowledge Tree Construction
39+
40+
- 🌱 **Seed Graph Schema**: Introduces targeted entity types, relations, and attribute types to bound automatic extraction agents
41+
- 📈 **Scalable Schema Expansion**: Continuously expands schemas for adaptability over unseen domains
42+
- 🏢 **Four-Level Architecture**:
43+
- **Level 1 (Attributes)**: Entity property information
44+
- **Level 2 (Relations)**: Entity relationship triples
45+
- **Level 3 (Keywords)**: Keyword indexing
46+
- **Level 4 (Communities)**: Hierarchical community structure
47+
-**Quick Adaptation to industrial applications**: We allow seamless domain transfer with minimal intervention on the schema
48+
49+
### 🌳 Dually-Perceived Community Detection
50+
51+
- 🔬 **Novel Community Detection Algorithm**: Fuses structural topology with subgraph semantics for comprehensive knowledge organization
52+
- 📊 **Hierarchical Knowledge Tree**: Naturally yields a structure supporting both top-down filtering and bottom-up reasoning that performs better than traditional Leiden and Louvain algorithms
53+
- 📝 **Community Summaries**: LLM-enhanced community summarization for higher-level knowledge abstraction
54+
55+
![](https://cdn.jsdelivr.net/gh/AllenWriter/picgo-images@main/images/202510201513515.png)
56+
57+
### 🤖 Agentic Retrieval
58+
59+
- 🎯 **Schema-Aware Decomposition**: Interprets the same graph schema to transform complex queries into tractable and parallel sub-queries
60+
- 🔄 **Iterative Reflection**: Performs reflection for more advanced reasoning through IRCoT (Iterative Retrieval Chain of Thought)
61+
62+
![](https://cdn.jsdelivr.net/gh/AllenWriter/picgo-images@main/images/202510201514908.png)
63+
64+
### 🧠 Advanced Construction and Reasoning Capabilities
65+
66+
- 🎯 **Performance Enhancement**: Less token costs and higher accuracy with optimized prompting, indexing and retrieval strategies
67+
- 🤹‍♀️ **User friendly visualization**: In `output/graphs/`, the four-level knowledge tree supports visualization with neo4j import,making reasoning paths and knowledge organization vividly visible to users
68+
-**Parallel Sub-question Processing**: Concurrent handling of decomposed questions for efficiency and complex scenarios
69+
- 🤔 **Iterative Reasoning**: Step-by-step answer construction with reasoning traces
70+
- 📊 **Domain Scalability**: Designed for enterprise-scale deployment with minimal manual intervention for new domains
71+
72+
### 📈 Fair Anonymous Dataset 'AnonyRAG'
73+
74+
- 🔗 **Dataset Link**: [Hugging Face AnonyRAG](https://huggingface.co/datasets/Youtu-Graph/AnonyRAG)
75+
- 🛡️ **Against knowledge leakage**: Prevents LLM/embedding model pretraining data contamination
76+
- 🔍 **Real retrieval testing**: In-depth test on real retrieval performance of GraphRAG
77+
- 🌍 **Multi-lingual support**: Available in Chinese and English versions
78+
79+
### ⚙️ Unified Configuration Management
80+
81+
- 🎛️ **Centralized Parameter Management**: All components configured through a single YAML file
82+
- 🔧 **Runtime Parameter Override**: Dynamic configuration adjustment during execution
83+
- 🌍 **Multi-Environment Support**: Seamless domain transfer with minimal intervention on schema
84+
- 🔄 **Backward Compatibility**: Ensures existing code continues to function
85+
86+
## 📊 Performance Comparisons
87+
88+
Extensive experiments across six challenging benchmarks, including GraphRAG-Bench, HotpotQA and MuSiQue, demonstrate the robustness of Youtu-GraphRAG, remarkably moving the Pareto frontier with **33.6% lower token cost** compared to the sota methods and **16.62% higher accuracy** over state-of-the-art baselines.
89+
90+
![](https://cdn.jsdelivr.net/gh/AllenWriter/picgo-images@main/images/202510201519961.png)
91+
92+
![](https://cdn.jsdelivr.net/gh/AllenWriter/picgo-images@main/images/202510201519950.png)
93+
94+
![](https://cdn.jsdelivr.net/gh/AllenWriter/picgo-images@main/images/202510201519584.png)
95+
96+
## Quick Start
97+
98+
**[📚 Complete Setup Guide](/docs/en/quick-start)** - Get started with Youtu-GraphRAG in minutes using Docker or Web UI.
99+
100+
## Project Structure
101+
102+
```
103+
youtu-graphrag/
104+
├── 📁 config/ # Configuration System
105+
│ ├── base_config.yaml # Main configuration file
106+
│ ├── config_loader.py # Configuration loader
107+
│ └── __init__.py # Configuration module interface
108+
109+
├── 📁 data/ # Data Directory
110+
111+
├── 📁 models/ # Core Models
112+
│ ├── 📁 constructor/ # Knowledge Graph Construction
113+
│ │ └── kt_gen.py # KTBuilder - Hierarchical graph builder
114+
│ ├── 📁 retriever/ # Retrieval Module
115+
│ │ ├── enhanced_kt_retriever.py # KTRetriever - Main retriever
116+
│ │ ├── agentic_decomposer.py # Query decomposer
117+
│ └── └── faiss_filter.py # DualFAISSRetriever - FAISS retrieval
118+
119+
├── 📁 utils/ # Utility Modules
120+
│ ├── tree_comm.py # community detection algorithm
121+
│ ├── call_llm_api.py # LLM API calling
122+
│ ├── eval.py # Evaluation tools
123+
│ └── graph_processor.py # Graph processing tools
124+
125+
├── 📁 output/ # Output Directory
126+
│ ├── graphs/ # Constructed knowledge graphs
127+
│ ├── chunks/ # Text chunk information
128+
│ └── logs/ # Runtime logs
129+
130+
├── main.py # 🎯 Main program entry
131+
└── README.md # Project documentation
132+
```
133+
134+
## Fair Anonymous Dataset 'AnonyRAG'
135+
136+
- **Against knowledge leakage in LLM/embedding model pretraining**
137+
- **In-depth test on real retrieval performance of GraphRAG**
138+
- **Multi-lingual with Chinese and English versions**
139+
140+
## Next Steps
141+
142+
After familiarizing yourself with the basic capabilities, proceed to [Quick Start](/docs/en/quick-start) to complete setup and start building your knowledge graphs.
143+
144+
Related Links:
145+
146+
<div className="space-y-3">
147+
<div className="flex items-center gap-3">
148+
<span className="w-6 h-6 bg-gray-200 rounded flex items-center justify-center">G</span>
149+
<a href="https://github.com/TencentCloudADP/youtu-graphrag" className="hover:underline">
150+
GitHub Repository
151+
</a>
152+
</div>
153+
<div className="flex items-center gap-3">
154+
<span className="w-6 h-6 bg-yellow-200 rounded flex items-center justify-center">H</span>
155+
<a href="https://huggingface.co/datasets/Youtu-Graph/AnonyRAG" className="hover:underline">
156+
AnonyRAG Dataset
157+
</a>
158+
</div>
159+
<div className="flex items-center gap-3">
160+
<span className="w-6 h-6 bg-red-200 rounded flex items-center justify-center">P</span>
161+
<a href="https://arxiv.org/abs/2508.19855" className="hover:underline">
162+
Academic Paper
163+
</a>
164+
</div>
165+
<div className="flex items-center gap-3">
166+
<span className="w-6 h-6 bg-blue-200 rounded flex items-center justify-center">D</span>
167+
<a href="https://deepwiki.com/TencentCloudADP/youtu-graphrag" className="hover:underline">
168+
DeepWiki Documentation
169+
</a>
170+
</div>
171+
</div>

0 commit comments

Comments
 (0)