update README.py

README.md

@@ -12,4 +12,88 @@ hf_oauth: true
 hf_oauth_expiration_minutes: 480
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# 🕵🏻‍♂️ Agents Course Final Assignment
+
+> **⚠️ Important Notice**: After this project is made public, the `OPENAI_API_KEY` in Hugging Face Space settings has been set to an invalid value to protect API key security. To run this project, please use your own OpenAI API key.
+
+This is a multi-agent system developed for the [Hugging Face Agents Course](https://huggingface.co/learn/agents-course/en/unit4/introduction) Unit 4 final project. The system is designed to evaluate AI agent performance through the [GAIA benchmark](https://huggingface.co/spaces/gaia-benchmark/leaderboard).
+
+## 🎯 Project Goals
+
+Create an agent system capable of achieving 30% or higher score on the GAIA benchmark to earn the course completion certificate 🏅.
+
+## 🏗️ Architecture Design
+
+This project adopts a multi-agent architecture with two specialized sub-agents:
+
+### 1. Web Search Agent
+- **Functions**: Web search, webpage access, Wikipedia queries
+- **Tools**: 
+  - `WebSearchTool()`: Web search
+  - `VisitWebpageTool()`: Access specific webpages
+  - `WikipediaSearchTool()`: Wikipedia search
+- **Authorized Imports**: `requests`, `beautifulsoup4`
+
+### 2. Calculation Agent
+- **Functions**: Mathematical calculations, data analysis, statistical computing
+- **Authorized Imports**: `pandas`, `numpy`, `math`, `statistics`, `scipy`
+- **Features**: Specialized in numerical computation and data processing tasks
+
+### 3. Main Agent
+- **Role**: Coordinate and manage sub-agents
+- **Functions**: Task distribution, result integration, decision making
+- **Features**: Uses `managed_agents` mode to uniformly manage sub-agents
+
+## 📁 Project Structure
+
+```
+├── agent.py          # Main agent definition and configuration
+├── prompt.py         # Agent prompt templates and system instructions
+├── app.py            # Gradio interface and GAIA evaluation logic
+├── test_agent.py     # Agent functionality test scripts
+├── requirements.txt  # Python dependencies
+├── pyproject.toml    # Project configuration file
+└── README.md         # Project documentation
+```
+
+## 🔧 Tech Stack
+
+- **AI Framework**: [smolagents](https://github.com/huggingface/smolagents) - Hugging Face's agent framework
+- **LLM**: OpenAI GPT-4.1 (via OpenAI API)
+- **Frontend Interface**: Gradio 5.34.0
+- **Data Processing**: pandas, numpy, scipy
+- **Web Requests**: requests, beautifulsoup4
+- **Environment Management**: python-dotenv
+
+## 🚀 Quick Start
+
+### Environment Setup
+
+1. **Clone the project**
+```bash
+git clone <repository-url>
+cd Agents-Course-Final-Assignment
+```
+
+2. **Install dependencies**
+```bash
+pip install -r requirements.txt
+```
+
+3. **Configure API Key**
+Create a `.env` file and add your OpenAI API key:
+```bash
+OPENAI_API_KEY=your_openai_api_key_here
+```
+
+## 🔗 Related Links
+
+- [Hugging Face Agents Course](https://huggingface.co/learn/agents-course/en/unit4/introduction)
+- [GAIA Benchmark](https://huggingface.co/spaces/gaia-benchmark/leaderboard)
+- [Student Leaderboard](https://huggingface.co/spaces/agents-course/Students_leaderboard)
+- [smolagents Documentation](https://github.com/huggingface/smolagents)
+
+
+---
+
+*Created with ❤️ for the Hugging Face Agents Course Final Assignment*