Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,237 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: mit
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
---
|
| 4 |
+
<p align="center">
|
| 5 |
+
<img src="public/paper-circle-logo.svg" alt="PaperCircle" width="140"/>
|
| 6 |
+
</p>
|
| 7 |
+
|
| 8 |
+
<h1 align="center">PaperCircle</h1>
|
| 9 |
+
|
| 10 |
+
<p align="center">
|
| 11 |
+
<b>An Open-source Multi-agent Research Discovery and Analysis Framework</b>
|
| 12 |
+
</p>
|
| 13 |
+
|
| 14 |
+
<p align="center">
|
| 15 |
+
<a href="https://papercircle.vercel.app"><img src="https://img.shields.io/badge/Live_Demo-papercircle.vercel.app-blue?logo=vercel" alt="Live Demo"/></a>
|
| 16 |
+
<a href="https://arxiv.org/abs/2604.06170"><img src="https://img.shields.io/badge/arXiv-Paper-b31b1b?logo=arxiv" alt="arXiv"/></a>
|
| 17 |
+
<a href="https://huggingface.co/spaces/ItsMaxNorm/pc-bench"><img src="https://img.shields.io/badge/%F0%9F%A4%97-Benchmark-orange" alt="Benchmark"/></a>
|
| 18 |
+
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT"/>
|
| 19 |
+
</p>
|
| 20 |
+
|
| 21 |
+
---
|
| 22 |
+
|
| 23 |
+
> **Paper Circle: An Open-source Multi-agent Research Discovery and Analysis Framework**
|
| 24 |
+
>
|
| 25 |
+
> Komal Kumar<sup>1</sup>, Aman Chadha<sup>2</sup>, Salman Khan<sup>1</sup>, Fahad Shahbaz Khan<sup>1</sup>, Hisham Cholakkal<sup>1</sup>
|
| 26 |
+
>
|
| 27 |
+
> <sup>1</sup> Mohamed bin Zayed University of Artificial Intelligence <sup>2</sup> AWS Generative AI Innovation Center, Amazon Web Services
|
| 28 |
+
>
|
| 29 |
+
> [[arXiv]](https://arxiv.org/abs/2604.06170) [[Live Demo]](https://papercircle.vercel.app) [[Benchmark]](https://huggingface.co/spaces/ItsMaxNorm/pc-bench)
|
| 30 |
+
|
| 31 |
+
---
|
| 32 |
+
|
| 33 |
+
## Architecture
|
| 34 |
+
|
| 35 |
+
<p align="center">
|
| 36 |
+
<img src="assets/paperdig/main_arc.png" alt="PaperCircle Architecture" width="100%"/>
|
| 37 |
+
</p>
|
| 38 |
+
|
| 39 |
+
---
|
| 40 |
+
|
| 41 |
+
## Results
|
| 42 |
+
|
| 43 |
+
<p align="center">
|
| 44 |
+
<img src="assets/paperdig/output_results_qualitative.png" alt="PaperCircle Qualitative Results" width="100%"/>
|
| 45 |
+
</p>
|
| 46 |
+
|
| 47 |
+
Qualitative output of the Paper Mind Graph module: **(A)** Interactive mind map flowchart extracted from a paper, **(B)** Extracted concepts with descriptions and page references, **(C)** Natural language Q&A over paper content with figure references, **(D)** Detailed method and component descriptions, **(E)** Tab navigation across Flowchart, Concepts, Methods, Experiments, and Interactive Graph views.
|
| 48 |
+
|
| 49 |
+
---
|
| 50 |
+
|
| 51 |
+
## Features
|
| 52 |
+
|
| 53 |
+
- **Paper Discovery** — Multi-agent AI search across arXiv, Scopus, and IEEE with hybrid BM25 + TF-IDF ranking and three discovery modes (Stable, Discovery, Balanced)
|
| 54 |
+
- **Paper Mind Graph** — LLM-powered extraction of concepts, methods, and experiments into structured knowledge graphs with interactive Q&A
|
| 55 |
+
- **Paper Review Generation** — Conference-format reviews (ICLR/NeurIPS/ICML style) via multi-agent analysis with lineage extraction
|
| 56 |
+
- **Paper Lineage** — Relationship mapping (extends/applies/evaluates/contradicts/survey/prerequisite) with interactive graph visualization
|
| 57 |
+
- **Reading Circles** — Community-based reading groups with role-based access, session scheduling, RSVP, and discussion threads
|
| 58 |
+
|
| 59 |
+
---
|
| 60 |
+
|
| 61 |
+
## Hugging Face Resources
|
| 62 |
+
|
| 63 |
+
| Resource | Type | Link |
|
| 64 |
+
|----------|------|------|
|
| 65 |
+
| **Papers Database** | Dataset | [ItsMaxNorm/pc-database](https://huggingface.co/datasets/ItsMaxNorm/pc-database) |
|
| 66 |
+
| **Papers API** | Space | [ItsMaxNorm/papercircle-papers-api](https://huggingface.co/spaces/ItsMaxNorm/papercircle-papers-api) |
|
| 67 |
+
| **Benchmark Leaderboard** | Space | [ItsMaxNorm/pc-bench](https://huggingface.co/spaces/ItsMaxNorm/pc-bench) |
|
| 68 |
+
| **Benchmark Results** | Dataset | [ItsMaxNorm/pc-benchmark](https://huggingface.co/datasets/ItsMaxNorm/pc-benchmark) |
|
| 69 |
+
| **Research Sessions** | Dataset | [ItsMaxNorm/pc-research](https://huggingface.co/datasets/ItsMaxNorm/pc-research) |
|
| 70 |
+
|
| 71 |
+
---
|
| 72 |
+
|
| 73 |
+
## Getting Started
|
| 74 |
+
|
| 75 |
+
### Prerequisites
|
| 76 |
+
|
| 77 |
+
- **Node.js** >= 18 and **Python** >= 3.10
|
| 78 |
+
- A [Supabase](https://supabase.com) project
|
| 79 |
+
- An LLM provider: [Ollama](https://ollama.com) (local), OpenAI, or Anthropic
|
| 80 |
+
|
| 81 |
+
### Install and Run
|
| 82 |
+
|
| 83 |
+
```bash
|
| 84 |
+
git clone https://github.com/MAXNORM8650/papercircle.git
|
| 85 |
+
cd papercircle
|
| 86 |
+
|
| 87 |
+
# Install
|
| 88 |
+
npm install
|
| 89 |
+
pip install -r backend/requirements-prod.txt
|
| 90 |
+
|
| 91 |
+
# Configure
|
| 92 |
+
cp .env.example .env # Edit with your Supabase & LLM credentials
|
| 93 |
+
|
| 94 |
+
# Run
|
| 95 |
+
npm run dev # Frontend (localhost:5173)
|
| 96 |
+
python backend/apis/fast_discovery_api.py # Discovery API (localhost:8000)
|
| 97 |
+
python backend/apis/paper_review_server.py # Review API (localhost:8005)
|
| 98 |
+
python backend/apis/paper_analysis_api.py # Analysis API (localhost:8006)
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
See [docs/QUICK_START.md](docs/QUICK_START.md) for detailed setup and [docs/DEPLOYMENT_GUIDE.md](docs/DEPLOYMENT_GUIDE.md) for production deployment.
|
| 102 |
+
|
| 103 |
+
---
|
| 104 |
+
|
| 105 |
+
## Project Structure
|
| 106 |
+
|
| 107 |
+
```
|
| 108 |
+
papercircle/
|
| 109 |
+
├── src/ # Frontend (React 18 + TypeScript)
|
| 110 |
+
│ ├── components/
|
| 111 |
+
│ │ ├── Papers/ # Paper discovery, detail, analysis views
|
| 112 |
+
│ │ ├── Lineage/ # Paper relationship graph & analysis hub
|
| 113 |
+
│ │ ├── Sessions/ # Session scheduling, RSVP, attendance
|
| 114 |
+
│ │ ├── Communities/ # Reading circle management
|
| 115 |
+
│ │ ├── Dashboard/ # User dashboard
|
| 116 |
+
│ │ ├── Auth/ # Authentication modals
|
| 117 |
+
│ │ ├── Layout/ # Header, navigation
|
| 118 |
+
│ │ ├── Admin/ # Admin panel
|
| 119 |
+
│ │ └── Settings/ # LLM & user settings
|
| 120 |
+
│ ├── contexts/ # AuthContext, CommunityContext, LineageAnalysisContext
|
| 121 |
+
│ ├── lib/ # Supabase client, API helpers, arXiv client
|
| 122 |
+
│ └── hooks/ # Custom React hooks
|
| 123 |
+
│
|
| 124 |
+
├── backend/
|
| 125 |
+
│ ├── agents/
|
| 126 |
+
│ │ ├── paper_review_agents/ # Multi-agent review generation & benchmarking
|
| 127 |
+
│ │ │ ├── orchestrator.py # Agent orchestration pipeline
|
| 128 |
+
│ │ │ ├── specialized_agents.py # Critic, Literature, Reproducibility agents
|
| 129 |
+
│ │ │ ├── benchmark_framework.py # Review benchmark framework
|
| 130 |
+
│ │ │ ├── benchmark_paper_review.py # Benchmark CLI
|
| 131 |
+
│ │ │ ├── evaluation_metrics.py # MSE, MAE, correlation, accuracy metrics
|
| 132 |
+
│ │ │ └── benchmark_results/ # Cached benchmark outputs
|
| 133 |
+
│ │ ├── paper_mind_graph/ # Knowledge graph extraction from PDFs
|
| 134 |
+
│ │ │ ├── graph_builder.py # LLM-based concept/method extraction
|
| 135 |
+
│ │ │ ├── qa_system.py # Interactive Q&A over papers
|
| 136 |
+
│ │ │ ├── ingestion.py # PDF parsing & chunking
|
| 137 |
+
│ │ │ └── export.py # JSON/Markdown/Mermaid/HTML export
|
| 138 |
+
│ │ ├── discovery/ # Paper discovery agents & ranking
|
| 139 |
+
│ │ └── agents/ # Core query & research agents
|
| 140 |
+
│ ├── apis/
|
| 141 |
+
│ │ ├── fast_discovery_api.py # Discovery API (port 8000)
|
| 142 |
+
│ │ ├── paper_review_server.py # Review API (port 8005)
|
| 143 |
+
│ │ ├── paper_analysis_api.py # Analysis API (port 8006)
|
| 144 |
+
│ │ ├── community_papers_api.py # Community papers API
|
| 145 |
+
│ │ ├── research_pipeline_api.py # Research pipeline API
|
| 146 |
+
│ │ └── unified/ # Unified Docker API (app.py + routers/)
|
| 147 |
+
│ ├── core/ # paperfinder.py, discovery_papers.py
|
| 148 |
+
│ ├── services/ # HuggingFace papers client
|
| 149 |
+
│ └── utils/ # Storage utilities
|
| 150 |
+
│
|
| 151 |
+
├── supabase/
|
| 152 |
+
│ ├── migrations/ # 55 SQL migrations (schema, RLS, seeds)
|
| 153 |
+
│ └── functions/ # Edge functions (arxiv-search)
|
| 154 |
+
│
|
| 155 |
+
├── api/ # Vercel serverless functions
|
| 156 |
+
│ ├── arxiv.js # arXiv CORS proxy
|
| 157 |
+
│ ├── community-papers.js # Community papers endpoint
|
| 158 |
+
│ └── sync-status.js # Sync status endpoint
|
| 159 |
+
│
|
| 160 |
+
├── scripts/ # Utility scripts
|
| 161 |
+
│ ├── javascript/ # arxiv-proxy, search engine, test scripts
|
| 162 |
+
│ ├── shell/ # Start scripts for each API service
|
| 163 |
+
│ └── *.py # Dataset builder, sync, DB fixes
|
| 164 |
+
│
|
| 165 |
+
├── docs/ # Documentation
|
| 166 |
+
│ ├── BENCHMARKS.md # Benchmark guide (review + retrieval)
|
| 167 |
+
│ ├── QUICK_START.md # Quick start guide
|
| 168 |
+
│ ├── DEPLOYMENT_GUIDE.md # Production deployment
|
| 169 |
+
│ ├── SECURITY.md # Security guidelines
|
| 170 |
+
│ ├── MIGRATION_COMPLETE.md # Serverless migration summary
|
| 171 |
+
│ └── PAPER_REVIEW_AGENTS_IMPLEMENTATION.md # Review system implementation
|
| 172 |
+
│
|
| 173 |
+
├── examples/
|
| 174 |
+
│ ├── pc-data/ # Benchmark datasets
|
| 175 |
+
│ └── docs/ # Architecture & integration guides
|
| 176 |
+
│ ├── ARCHITECTURE_DIAGRAMS.md # System diagrams
|
| 177 |
+
│ ├── MULTI_AGENT_PIPELINE_ARCHITECTURE.md
|
| 178 |
+
│ ├── ORCHESTRATOR_ARCHITECTURE.md
|
| 179 |
+
│ ├── PAPER_MIND_GRAPH_ARCHITECTURE.md
|
| 180 |
+
│ ├── AGENT_OPTIMIZATION_GUIDE.md
|
| 181 |
+
│ ├── RERANKER_INTEGRATION_SUMMARY.md
|
| 182 |
+
│ └── setup/ # Module setup & integration guides
|
| 183 |
+
│
|
| 184 |
+
├── hf_spaces/ # HuggingFace Spaces (Papers API app)
|
| 185 |
+
├── assets/ # Architecture & results figures
|
| 186 |
+
└── public/ # Logo and static assets
|
| 187 |
+
```
|
| 188 |
+
|
| 189 |
+
---
|
| 190 |
+
|
| 191 |
+
## Benchmarks
|
| 192 |
+
|
| 193 |
+
Two evaluation suites: **Review Quality** (AI reviews vs human reviewers) and **Retrieval Quality** (paper search accuracy).
|
| 194 |
+
|
| 195 |
+
| Benchmark | Metrics | Conferences | Details |
|
| 196 |
+
|-----------|---------|-------------|---------|
|
| 197 |
+
| **Paper Review** | MSE, MAE, Pearson r, Spearman ρ, Accuracy ±0.5/1.0/1.5 | ICLR, NeurIPS, ICML | [docs/BENCHMARKS.md](docs/BENCHMARKS.md) |
|
| 198 |
+
| **Retrieval** | Recall@k, MRR, Success Rate | 30+ conferences | [docs/BENCHMARKS.md](docs/BENCHMARKS.md) |
|
| 199 |
+
|
| 200 |
+
```bash
|
| 201 |
+
# Review benchmark
|
| 202 |
+
python backend/agents/paper_review_agents/benchmark_paper_review.py \
|
| 203 |
+
--data iclr2024.json --conference iclr --limit 100
|
| 204 |
+
|
| 205 |
+
# Retrieval benchmark
|
| 206 |
+
python benchmark_multiagent.py --queries queries.json --baseline bm25+reranker
|
| 207 |
+
```
|
| 208 |
+
|
| 209 |
+
Model results: [ItsMaxNorm/pc-benchmark](https://huggingface.co/datasets/ItsMaxNorm/pc-benchmark) Interactive leaderboard: [ItsMaxNorm/pc-bench](https://huggingface.co/spaces/ItsMaxNorm/pc-bench)
|
| 210 |
+
|
| 211 |
+
---
|
| 212 |
+
|
| 213 |
+
## Citation
|
| 214 |
+
|
| 215 |
+
If you find PaperCircle useful in your research, please cite our paper:
|
| 216 |
+
|
| 217 |
+
```bibtex
|
| 218 |
+
misc{kumar2026papercircleopensourcemultiagent,
|
| 219 |
+
title={Paper Circle: An Open-source Multi-agent Research Discovery and Analysis Framework},
|
| 220 |
+
author={Komal Kumar and Aman Chadha and Salman Khan and Fahad Shahbaz Khan and Hisham Cholakkal},
|
| 221 |
+
year={2026},
|
| 222 |
+
eprint={2604.06170},
|
| 223 |
+
archivePrefix={arXiv},
|
| 224 |
+
primaryClass={cs.CL},
|
| 225 |
+
url={https://arxiv.org/abs/2604.06170},
|
| 226 |
+
}
|
| 227 |
+
```
|
| 228 |
+
|
| 229 |
+
---
|
| 230 |
+
|
| 231 |
+
## License
|
| 232 |
+
|
| 233 |
+
MIT License — see [LICENSE](LICENSE)
|
| 234 |
+
|
| 235 |
+
## Acknowledgments
|
| 236 |
+
|
| 237 |
+
[arXiv](https://arxiv.org) • [Supabase](https://supabase.com) • [smolagents](https://github.com/huggingface/smolagents) • [LiteLLM](https://github.com/BerriAI/litellm) • [Ollama](https://ollama.com) • [Hugging Face](https://huggingface.co)
|