ItsMaxNorm commited on
Commit
9effa32
·
verified ·
1 Parent(s): f021e63

Create README.md

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