Spaces:
Runtime error
Runtime error
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,69 +1,42 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
emoji: ๐
|
| 4 |
-
colorFrom: blue
|
| 5 |
-
colorTo: purple
|
| 6 |
-
sdk: gradio
|
| 7 |
-
sdk_version: 5.44.1
|
| 8 |
-
app_file: app.py
|
| 9 |
-
pinned: false
|
| 10 |
-
license: openrail
|
| 11 |
-
---
|
| 12 |
|
| 13 |
-
|
| 14 |
-
|
| 15 |
-
An advanced AI assistant with academic research capabilities powered by GPT-OSS 20B model.
|
| 16 |
|
| 17 |
## Features
|
| 18 |
|
| 19 |
-
|
| 20 |
-
- **
|
| 21 |
-
- **
|
| 22 |
-
- **
|
| 23 |
-
|
| 24 |
-
|
| 25 |
-
- **Web Search**: Integrated Tavily search engine
|
| 26 |
-
- **Academic Paper Analysis**: arXiv and Semantic Scholar integration
|
| 27 |
-
- **PDF Processing**: Direct analysis of research documents
|
| 28 |
-
- **Literature Reviews**: Automated literature review generation
|
| 29 |
-
- **Citation Management**: Bibliography and citation generation
|
| 30 |
-
- **URL Analysis**: Process any webpage or document URL
|
| 31 |
-
|
| 32 |
-
### ๐ ๏ธ Advanced Features
|
| 33 |
-
- **Research Mode**: Specialized handling for academic queries
|
| 34 |
-
- **Export Functionality**: Save conversations in JSON/Text formats
|
| 35 |
-
- **Follow-up Questions**: AI-suggested next questions
|
| 36 |
-
- **Dark/Light Theme**: Customizable interface
|
| 37 |
-
- **Rate Limiting**: Prevent API abuse
|
| 38 |
-
- **Usage Analytics**: Track performance metrics
|
| 39 |
|
| 40 |
-
|
| 41 |
-
- **Tabbed Interface**: Organized chat and research tools
|
| 42 |
-
- **Feedback System**: Rate response quality
|
| 43 |
-
- **Export Options**: Save your research
|
| 44 |
-
- **Responsive Design**: Works on all devices
|
| 45 |
|
| 46 |
-
|
|
|
|
|
|
|
|
|
|
| 47 |
|
| 48 |
-
|
| 49 |
-
2. Install dependencies: `pip install -r requirements.txt`
|
| 50 |
-
3. Run the app: `python app.py`
|
| 51 |
-
|
| 52 |
-
## Usage Tips
|
| 53 |
|
| 54 |
-
-
|
| 55 |
-
-
|
| 56 |
-
-
|
| 57 |
-
- Generate literature reviews for research topics
|
| 58 |
-
- Export your conversations for later reference
|
| 59 |
|
| 60 |
-
##
|
| 61 |
|
| 62 |
-
|
| 63 |
-
|
|
|
|
|
|
|
|
|
|
| 64 |
|
| 65 |
-
##
|
| 66 |
|
| 67 |
-
|
|
|
|
|
|
|
| 68 |
|
| 69 |
-
|
|
|
|
| 1 |
+
# README.md
|
| 2 |
+
# AI Research Assistant
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
|
| 4 |
+
This is an AI-powered research assistant that helps you quickly gather and analyze information on any topic. It combines web search capabilities with advanced language models to provide structured, cited research summaries.
|
|
|
|
|
|
|
| 5 |
|
| 6 |
## Features
|
| 7 |
|
| 8 |
+
- **Web Search Integration**: Uses Tavily API to find recent and relevant information
|
| 9 |
+
- **AI Analysis**: Processes information using a custom large language model
|
| 10 |
+
- **Citation Management**: Automatically tracks and formats sources
|
| 11 |
+
- **Structured Output**: Organizes information into clear sections
|
| 12 |
+
- **Streaming Updates**: Shows progress during processing
|
| 13 |
+
- **Logging**: Comprehensive logging for debugging and monitoring
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 14 |
|
| 15 |
+
## How to Use
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
|
| 17 |
+
1. Enter a research question in the input box
|
| 18 |
+
2. Click "Research" or press Enter
|
| 19 |
+
3. Watch the progress indicators as your research is processed
|
| 20 |
+
4. Get a comprehensive analysis with sources
|
| 21 |
|
| 22 |
+
## Example Queries
|
|
|
|
|
|
|
|
|
|
|
|
|
| 23 |
|
| 24 |
+
- "Latest advancements in quantum computing"
|
| 25 |
+
- "Impact of climate change on global agriculture"
|
| 26 |
+
- "Recent developments in Alzheimer's treatment research"
|
|
|
|
|
|
|
| 27 |
|
| 28 |
+
## Setup for Local Development
|
| 29 |
|
| 30 |
+
1. Install requirements: `pip install -r requirements.txt`
|
| 31 |
+
2. Set environment variables:
|
| 32 |
+
- `TAVILY_API_KEY`=your_tavily_api_key
|
| 33 |
+
- `HF_TOKEN`=your_huggingface_token
|
| 34 |
+
3. Run the app: `python app.py`
|
| 35 |
|
| 36 |
+
## Environment Variables
|
| 37 |
|
| 38 |
+
For deployment on Hugging Face Spaces, you need to set:
|
| 39 |
+
- `TAVILY_API_KEY`: Your Tavily API key for web search
|
| 40 |
+
- `HF_TOKEN`: Your Hugging Face access token for model access
|
| 41 |
|
| 42 |
+
These should be added as Secrets in your Space settings.
|