Spaces:
Sleeping
Sleeping
final changes.
Browse files
README.md
CHANGED
|
@@ -17,26 +17,52 @@ contributors:
|
|
| 17 |
|
| 18 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
| 19 |
|
| 20 |
-
demo-link: https://drive.google.com/file/d/
|
| 21 |
|
| 22 |
# Deep Research Assistant
|
| 23 |
|
| 24 |
-
|
| 25 |
|
| 26 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 27 |
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
-
-
|
|
|
|
|
|
|
| 32 |
|
| 33 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
-
1. Clone the repository
|
| 36 |
2. Install dependencies:
|
| 37 |
```bash
|
| 38 |
pip install -r requirements.txt
|
| 39 |
```
|
|
|
|
| 40 |
3. Create a `.env` file in the root directory with your API key:
|
| 41 |
```
|
| 42 |
GOOGLE_API_KEY="<get api key from https://console.cloud.google.com/apis/credentials>"
|
|
@@ -45,23 +71,42 @@ A Gradio web application that performs comprehensive research on any query using
|
|
| 45 |
FIRECRAWL_API_KEY="<get api key from https://www.firecrawl.dev/app/api-keys>"
|
| 46 |
```
|
| 47 |
|
| 48 |
-
## Running
|
| 49 |
|
| 50 |
1. Start the Gradio web interface:
|
| 51 |
```bash
|
| 52 |
python app.py
|
| 53 |
```
|
| 54 |
2. Open your web browser and navigate to the URL shown in the terminal (typically http://localhost:7860)
|
| 55 |
-
3. Enter your research query
|
| 56 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
|
| 58 |
-
##
|
| 59 |
|
| 60 |
-
|
| 61 |
-
-
|
| 62 |
-
-
|
| 63 |
-
- Emerging trends in artificial intelligence
|
| 64 |
|
| 65 |
-
##
|
| 66 |
|
| 67 |
-
|
|
|
|
| 17 |
|
| 18 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
| 19 |
|
| 20 |
+
demo-link: https://drive.google.com/file/d/1Xrj-5z2tcJYq124wlJndcJbVjHmP_Jos/view?usp=sharing
|
| 21 |
|
| 22 |
# Deep Research Assistant
|
| 23 |
|
| 24 |
+
An advanced AI-powered research assistant that performs comprehensive analysis and generates detailed reports on any topic. Built with Gradio and powered by Cerebras AI, Google search engine API.
|
| 25 |
|
| 26 |
+
## π₯ Demo Video
|
| 27 |
+
<div align="center">
|
| 28 |
+
<a href="https://drive.google.com/file/d/1Xrj-5z2tcJYq124wlJndcJbVjHmP_Jos/view?usp=sharing">
|
| 29 |
+
<img src="https://img.shields.io/badge/Watch%20Demo-Video-red?style=for-the-badge&logo=youtube" alt="Watch Demo Video"/>
|
| 30 |
+
</a>
|
| 31 |
+
</div>
|
| 32 |
|
| 33 |
+
## π Try It Live
|
| 34 |
+
<div align="center">
|
| 35 |
+
<a href="https://huggingface.co/spaces/suchith-koduru/deepsearch">
|
| 36 |
+
<img src="https://img.shields.io/badge/π€%20Open%20In%20Spaces-blue?style=for-the-badge" alt="Open in Spaces"/>
|
| 37 |
+
</a>
|
| 38 |
+
</div>
|
| 39 |
|
| 40 |
+
## π Features
|
| 41 |
+
|
| 42 |
+
- **Comprehensive Research**: Performs deep analysis using multiple research tools and AI models
|
| 43 |
+
- **Structured Reports**: Generates well-organized reports with:
|
| 44 |
+
- Executive Summary
|
| 45 |
+
- Main Findings with supporting details
|
| 46 |
+
- In-depth Analysis
|
| 47 |
+
- Clear Conclusions
|
| 48 |
+
- Source Citations
|
| 49 |
+
- **Real-time Processing**: Get research results in real-time with live progress updates
|
| 50 |
+
- **User-friendly Interface**: Simple, clean Gradio interface for easy interaction
|
| 51 |
+
- **Markdown Support**: Results are formatted in clean, readable markdown
|
| 52 |
+
|
| 53 |
+
## π οΈ Setup
|
| 54 |
+
|
| 55 |
+
1. Clone the repository:
|
| 56 |
+
```bash
|
| 57 |
+
git clone https://github.com/YourUsername/deepsearch.git
|
| 58 |
+
cd deepsearch
|
| 59 |
+
```
|
| 60 |
|
|
|
|
| 61 |
2. Install dependencies:
|
| 62 |
```bash
|
| 63 |
pip install -r requirements.txt
|
| 64 |
```
|
| 65 |
+
|
| 66 |
3. Create a `.env` file in the root directory with your API key:
|
| 67 |
```
|
| 68 |
GOOGLE_API_KEY="<get api key from https://console.cloud.google.com/apis/credentials>"
|
|
|
|
| 71 |
FIRECRAWL_API_KEY="<get api key from https://www.firecrawl.dev/app/api-keys>"
|
| 72 |
```
|
| 73 |
|
| 74 |
+
## πββοΈ Running Locally
|
| 75 |
|
| 76 |
1. Start the Gradio web interface:
|
| 77 |
```bash
|
| 78 |
python app.py
|
| 79 |
```
|
| 80 |
2. Open your web browser and navigate to the URL shown in the terminal (typically http://localhost:7860)
|
| 81 |
+
3. Enter your research query and click submit
|
| 82 |
+
|
| 83 |
+
## π Example Queries
|
| 84 |
+
|
| 85 |
+
The application works best with specific, focused queries. Here are some examples:
|
| 86 |
+
- "What are the latest developments in quantum computing?"
|
| 87 |
+
- "Explain the current state of climate change and its impacts"
|
| 88 |
+
- "What are the emerging trends in artificial intelligence?"
|
| 89 |
+
|
| 90 |
+
## π How It Works
|
| 91 |
+
|
| 92 |
+
1. **Query Refinement**: Your input is analyzed and structured into a comprehensive research query
|
| 93 |
+
2. **Research Phase**: Multiple tools are used to gather and analyze information:
|
| 94 |
+
- Web searching for recent information
|
| 95 |
+
- Content scraping for detailed analysis
|
| 96 |
+
- Text summarization for key points
|
| 97 |
+
3. **Report Generation**: Results are compiled into a structured report with:
|
| 98 |
+
- Executive Summary
|
| 99 |
+
- Main Findings
|
| 100 |
+
- Detailed Analysis
|
| 101 |
+
- Conclusions
|
| 102 |
+
- Source Citations
|
| 103 |
|
| 104 |
+
## β οΈ Important Notes
|
| 105 |
|
| 106 |
+
- Requires valid API keys for all services (Google Search, Cerebras AI, Firecrawl)
|
| 107 |
+
- Some queries may take a few minutes to process depending on complexity
|
| 108 |
+
- Internet connection required for real-time research
|
|
|
|
| 109 |
|
| 110 |
+
## π€ Contributing
|
| 111 |
|
| 112 |
+
Contributions are welcome! Please feel free to submit a Pull Request.
|