dlaima's picture
Update README.md
531ca97 verified
---
title: GalaGuide Agentic RAG
emoji: πŸ’»
colorFrom: yellow
colorTo: red
sdk: gradio
sdk_version: 5.30.0
app_file: app.py
pinned: false
license: mit
short_description: 🎩 Elegant & Professional GalaGuide
---
# 🎩 Elegant & Professional GalaGuide
A sleek, intelligent assistant app designed to support event organizers during a gala by providing personalized guest experiences and real-time support.
> πŸ§‘β€πŸ« This app is part of the **Hugging Face Courses** series and was developed as an educational project to showcase how machine learning
> can be used in real-world event scenarios. Learn more at [Hugging Face Courses](https://huggingface.co/learn).
---
### πŸ—‚ Folder Structure
```
GalaGuide Agentic RAG_app/
β”‚
β”œβ”€β”€ app.py # Main launcher script that initializes and runs the Gradio app.
β”œβ”€β”€ tools.py # Tools definitions (e.g Web search tool (e.g., DuckDuckGo, ContextualWeb), Weather info tool (dummy or real API integration), etc)
β”œβ”€β”€ retriever.py # Guest info retriever logic (CSV/JSON dataset support)
β”œβ”€β”€ .env.template # Template file showing expected environment variables (e.g., API keys).
β”œβ”€β”€ requirements.txt # Python dependencies
└── README.md # Project overview, setup instructions, usage examples
```
## ✨ Features
- βœ… Loads the Hugging Face guest dataset by default
- βœ… Allows uploading custom guest lists (CSV or JSON)
- βœ… Offers sample data for exploration
- βœ… Uses AI to generate conversation starters and guest insights
- βœ… Displays structured guest info including relationships, interests, and bios
- βœ… Pre-event, in-event, and post-event support capabilities
---
## 🧠 Capabilities Overview
### 🎟️ Guest Management
| Task | Description |
|---------------------|----------------------------------------------------|
| πŸ“‡ Guest Lookup | Retrieve profiles using name, email, or relation |
| 🧠 Personalized Intros | Suggest how to approach guests based on their interests |
### πŸ—£οΈ Conversation & Networking Help
| Task | Description |
|--------------------------|--------------------------------------------------------------------|
| πŸ’¬ Conversation Starters | Suggest icebreakers based on a guest’s background |
| πŸ“Ž Guest Matchmaking | Recommend attendees to meet based on shared interests |
| πŸ—‚οΈ Topic Summaries | Provide short summaries of key topics (e.g., AI, climate policy) |
| 🧠 Prep Notes | Brief you on a guest’s role before meeting them |
### πŸ”§ Event Tools
| Tool | Purpose |
|-------------------------|----------------------------------------------------------------------|
| WeatherInfoTool | Inform guests about weather/coat preparation |
| NewsSearchTool | Fetch relevant news related to event themes |
| DuckDuckGoSearchTool | General-purpose web search during Q&A or open discussions |
---
## πŸ› οΈ How to Use
1. Launch the app in your browser (hosted on Hugging Face Spaces)
2. πŸ“€ Upload your own `CSV` or `JSON` guest file with your custom guest list β€” or use the default dataset πŸ“₯ [Download sample_guests.csv](#)
3. Browse guest profiles, get insights, and use tools for networking and event prep
4. πŸ’‘ Suggested prompts are available directly in the app interface for inspiration.
---
## 🀝 Contributing
We welcome contributions to improve GalaGuide!
1. Fork the repository
2. Create a new branch:
```bash
git checkout -b feature-xyz
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference