Files changed (1) hide show
  1. README.md +125 -75
README.md CHANGED
@@ -1,6 +1,7 @@
1
  ---
2
- title: ReMind
3
- emoji: 🧠
 
4
  colorFrom: blue
5
  colorTo: purple
6
  sdk: gradio
@@ -15,109 +16,158 @@ tags:
15
  - bookmarks
16
  - web-search
17
  - agent-demo-track
 
18
  ---
19
 
20
- # 🧠 ReMind - Digital Assistant
 
 
21
 
22
- **Agents-MCP-Hackathon 2025 Submission - Track 3: Agentic Demo Showcase**
23
 
24
- A comprehensive digital assistant that combines Gmail management, Chrome bookmarks, and web search capabilities through an intelligent multi-agent system.
 
 
 
 
 
 
 
 
 
 
 
 
 
25
 
26
- ## Features
27
 
28
- - 🤖 **Multi-Agent Architecture**: Specialized agents for different tasks using SmolagentS
29
- - 📧 **Gmail Integration**: Read, search, and manage emails through Google API
30
- - 🔖 **Smart Bookmarks**: Parse and search Chrome bookmarks with AI categorization
31
- - 🌐 **Web Search**: Real-time web search capabilities with intelligent responses
32
- - 💭 **Real-time Thinking**: Watch the AI think through problems step-by-step
33
- - 🎯 **AI Categorization**: Intelligent categorization of content and information
34
 
35
- ## 🎯 Hackathon Track
36
 
37
- This submission is for **Track 3: Agentic Demo Showcase** - demonstrating the power of AI agents in a practical, user-friendly application.
38
 
39
- ## 🛠Technology Stack
40
 
41
- - **Gradio 5.0**: Modern web interface
42
- - **SmolagentS**: Multi-agent framework for AI coordination
43
- - **Google APIs**: Gmail integration
44
- - **Real-time Processing**: Live thinking display and response streaming
 
 
 
 
 
 
 
 
 
 
 
 
45
 
46
- ## 🚀 Key Capabilities
47
 
48
- ### 📧 Email Management
49
- - Search through Gmail messages
50
- - Read and analyze email content
51
- - Smart email categorization and insights
52
 
53
- ### 🔖 Bookmarks Intelligence
54
- - Import and analyze Chrome bookmarks
55
- - AI-powered categorization
56
- - Smart search and recommendations
57
 
58
- ### 🌐 Web Search & Research
59
- - Real-time web search capabilities
60
- - Intelligent information synthesis
61
- - Context-aware responses
62
 
63
- ### 🤔 Transparent AI Thinking
64
- - Watch the AI's reasoning process in real-time
65
- - Understand how decisions are made
66
- - Educational insight into agent behavior
67
 
68
- ## 💡 Agent Architecture
 
 
69
 
70
- The system uses a sophisticated multi-agent approach:
71
 
72
- 1. **Manager Agent**: Orchestrates tasks and delegates to specialists
73
- 2. **Gmail Agent**: Handles all email-related operations
74
- 3. **Bookmarks Agent**: Manages bookmark analysis and search
75
- 4. **Categorizer Agent**: Provides AI-powered categorization
76
- 5. **Web Agents**: Handle search and real-time information retrieval
77
 
78
- ## 🎥 Demo Video
79
 
80
- [Link to demo video showing ReMind in action]
81
 
82
- ## 🔧 Setup for Gmail Integration
83
 
84
- To enable Gmail features, configure these environment variables in your Space:
 
 
 
85
 
86
- ```
87
- GOOGLE_CLIENT_ID=your_oauth_client_id
88
- GOOGLE_CLIENT_SECRET=your_oauth_client_secret
89
- GOOGLE_REFRESH_TOKEN=your_refresh_token
90
- HF_TOKEN=your_hugging_face_token
91
- ```
92
 
93
- ## 🏆 Hackathon Innovation
94
 
95
- ReMind showcases several innovative aspects:
 
 
 
 
 
 
 
 
 
 
96
 
97
- - **Unified Interface**: Single chat interface for multiple productivity tools
98
- - **Transparent AI**: Real-time thinking display for educational value
99
- - **Practical Integration**: Real-world APIs (Gmail) with AI enhancement
100
- - **Smart Categorization**: AI-powered organization of digital content
101
- - **Multi-Agent Coordination**: Sophisticated task delegation and management
 
 
 
 
 
 
 
 
 
 
 
 
 
 
102
 
103
- ## 🌟 User Experience
104
 
105
- The interface provides:
106
- - Clean, intuitive chat interface
107
- - Real-time thinking visualization
108
- - Responsive design for all devices
109
- - Error handling and user guidance
110
- - Progressive feature discovery
 
 
 
111
 
112
- ## 📚 Use Cases
 
 
 
 
 
 
 
 
113
 
114
- Perfect for users who want to:
115
- - Manage email more efficiently with AI assistance
116
- - Organize and search bookmarks intelligently
117
- - Get quick answers with web search integration
118
- - Learn how AI agents coordinate and think
119
- - Streamline daily digital productivity tasks
120
 
121
  ---
122
 
123
- *Built for the Agents-MCP-Hackathon 2025 by Habib*
 
1
  ---
2
+
3
+ title: ReMind — Your Second 🧠
4
+ emoji: "🧠"
5
  colorFrom: blue
6
  colorTo: purple
7
  sdk: gradio
 
16
  - bookmarks
17
  - web-search
18
  - agent-demo-track
19
+
20
  ---
21
 
22
+ # 🧠 ReMind Bring your past to mind
23
+
24
+ **ReMind is a unified digital-memory assistant that learns from your AI newsletters, curates your Chrome bookmarks, and lets you query both in natural language—all orchestrated by a multi-agent system.**
25
 
26
+ Built for the **Agents & MCP Hackathon 2025 Track 3: Agentic Demo Showcase**.
27
 
28
+ > *"Email that teaches me, bookmarks that remember for me, answers when I need them."*
29
+
30
+ ---
31
+
32
+ ## ✨ Why ReMind?
33
+
34
+ | Pain | ReMind Solution |
35
+ | ------------------------------------------------ | ------------------------------------------------------- |
36
+ | Newsletter overload every morning | One-click OAuth fetch, auto-tagging & summarisation |
37
+ | Thousand-tab bookmark graveyard | AI categorisation & semantic search |
38
+ | Context-switching between inbox, browser, search | Single chat interface powered by agents |
39
+ | Opaque AI answers | Real-time “thought process” trace & clickable citations |
40
+
41
+ ---
42
 
43
+ ## 🚀 Live Demo — 30-Second Flow
44
 
45
+ 1. **Open the Space** and switch to **Tab 1 Connect**.
46
+ 2. Click **“Connect Gmail”**, grant read-only access, then hit **“Ingest”**.
47
+ 3. Jump to **Tab 2 — Analytics** to see tag clouds and sender stats.
48
+ 4. Ask questions in **Tab 3 Ask ReMind** e.g. “Summarise recent Anthropic updates.”
49
+ 5. Watch the agents think, then follow the citations back to the original email or bookmark.
 
50
 
51
+ [▶︎ **4-min video demo**](https://youtu.be/xxxxxxxx)
52
 
53
+ ---
54
 
55
+ ## 🏗Repo Layout (monorepo-style)
56
 
57
+ ```
58
+ ReMind/
59
+ ├─ config/ # default prompts, yaml configs
60
+ ├─ data/ # sample inbox & bookmark JSON (redacted)
61
+ ├─ src/ # package root (importable as `remind`)
62
+ │ ├─ agents/ # Manager, Gmail, Bookmark, RAG, etc.
63
+ │ ├─ interfaces/ # Gradio Blocks & helper UI widgets
64
+ │ ├─ tools/ # Gmail API wrapper, bookmark parser, utils
65
+ │ ├─ __init__.py
66
+ │ └─ main.py # entrypoint when imported as a module
67
+ ├─ app.py # HF Spaces entrypoint (imports src.main)
68
+ ├─ .env.example # copy → .env and fill in secrets
69
+ ├─ requirements.txt # runtime deps
70
+ ├─ pyproject.toml # tooling & formatting
71
+ └─ README.md # you are here
72
+ ```
73
 
74
+ The **root‐level `app.py`** is the single entrypoint required by Hugging Face Spaces. It bootstraps the Gradio UI by calling `remind.interfaces.build()` inside `src/`.
75
 
76
+ ---
 
 
 
77
 
78
+ ## ⚙️ Quick Start (Local Dev)
 
 
 
79
 
80
+ ```bash
81
+ # 1. Clone & install
82
+ $ git clone https://github.com/your-org/remind.git && cd remind
83
+ $ pip install -r requirements.txt
84
 
85
+ # 2. Configure secrets
86
+ $ cp .env.example .env # then paste your tokens
 
 
87
 
88
+ # 3. Launch the app
89
+ $ python app.py # opens http://localhost:7860
90
+ ```
91
 
92
+ ### Required Environment Variables
93
 
94
+ | Key | Description |
95
+ | ---------------------------------------------- | -------------------------------------------------------- |
96
+ | `HF_TOKEN` | Hugging Face token for optional Inference API calls |
97
+ | `GOOGLE_CLIENT_ID` / `GOOGLE_CLIENT_SECRET` | OAuth credentials from Google Cloud Console |
98
+ | `GOOGLE_REFRESH_TOKEN` / `GOOGLE_ACCESS_TOKEN` | Generated by `python scripts/setup_gmail_credentials.py` |
99
 
100
+ > **Tip Gmail setup**: Run `python scripts/setup_gmail_credentials.py` (included in `src/tools`) once. It opens a browser window, you sign in, and it prints the refresh & access tokens for `.env`.
101
 
102
+ ---
103
 
104
+ ## 🛠️ Key Components
105
 
106
+ * **Multi-Agent Orchestrator** — built with *SmolagentS*; assigns Gmail parsing, bookmarking, and RAG tasks to specialists.
107
+ * **LLM Stack** — OpenAI GPT-4o for reasoning, ADA-002 for embeddings (pluggable).
108
+ * **Vector Store** — in-memory FAISS during hackathon (MongoDB Atlas planned).
109
+ * **Gradio 5 UI** — three-tab layout + real-time agent “thoughts” accordion.
110
 
111
+ ---
 
 
 
 
 
112
 
113
+ ## 🎯 Core Features (MVP)
114
 
115
+ 1. **Gmail Ingestion (read-only)**
116
+ • Detect newsletters via `List-Unsubscribe` header
117
+ • Parse HTML → Markdown → clean text
118
+ 2. **Bookmark Brain**
119
+ • Import `Bookmarks.json`
120
+ • Zero-shot topic tagging
121
+ 3. **Natural-Language Q\&A**
122
+ • RAG over combined email+bookmark corpus
123
+ • Inline citations
124
+ 4. **Analytics Dashboard**
125
+ • Tag cloud, sender histogram, engagement insights
126
 
127
+ ---
128
+
129
+ ## 🛣️ Roadmap (Post-Hackathon)
130
+
131
+ * Gmail push notifications for near real-time ingest
132
+ * Atlas Vector Search backend
133
+ * Shared team workspaces
134
+ * Mobile PWA wrapper
135
+
136
+ Contribute ideas → [Discussions](https://huggingface.co/spaces/Agents-MCP-Hackathon/ReMind/discussions).
137
+
138
+ ---
139
+
140
+ ## 🤝 Contributing
141
+
142
+ PRs welcome! During hack-week we operate on a **fast-merge** basis.
143
+
144
+ * README with live demo & video ✔️
145
+ * HF Space public & reproducible ✔️
146
 
147
+ If ReMind sparks joy, **⭐️ the repo & “Like” the Space** — community engagement counts!
148
 
149
+ ---
150
+
151
+ ## 👩‍💻 Authors
152
+
153
+ | Name | GitHub | Role |
154
+ | ------------ | -------------------------------------------------- | ------------------------------------ |
155
+ | Habib Adoum | [@GhostDragon01](https://github.com/GhostDragon01) | Lead Full-Stack & Agent Orchestrator |
156
+ | Omar Issa | [@omarissa24](https://github.com/omarissa24) | Contributor |
157
+ | Ziad Mazzawi | [@zmazz](https://github.com/zmazz) | Contributor |
158
 
159
+ Thanks to **Modal Labs**, **Hugging Face**, **OpenAI**, **MistralAI**, and **Anthropic** for credits that power this demo.
160
+
161
+ ---
162
+
163
+ ## 📄 License
164
+
165
+ MIT — free to fork & learn. See `LICENSE`.
166
+
167
+ ---
168
 
169
+ > May your inbox be calm and your bookmarks memorable.
 
 
 
 
 
170
 
171
  ---
172
 
173
+ *Built for the Agents-MCP-Hackathon 2025 by Habib*