ScholarBot / README.md
vinny4's picture
changed readme file
3586d61
---
title: ScholarBot
emoji: πŸ“š
colorFrom: indigo
colorTo: blue
sdk: streamlit
sdk_version: "1.35.0"
python_version: "3.10"
app_file: app/app.py
suggested_hardware: cpu-basic
suggested_storage: medium
fullWidth: true
header: default
short_description: "Chat with your research papers"
tags:
- rag
- langchain
- streamlit
- chatbot
- document-qa
- ai-research
- huggingface
- vector-database
pinned: true
---
# πŸ€– ScholarBot
**ScholarBot** is an AI-powered research assistant that enables you to upload research papers and chat with them. It leverages cutting-edge Retrieval-Augmented Generation (RAG) pipelines and large language models (LLMs) to ground responses in the actual content of uploaded PDFs.
---
## Getting Started (Local Setup)
```bash
# Clone the repo
git clone https://huggingface.co/spaces/vinny4/ScholarBot
cd ScholarBot
# Install dependencies
pip install -r requirements.txt
# Create a .env file with OPENAI_API_KEY and GROQ_API_KEY
echo "OPENAI_API_KEY=your_openai_api_key" > .env
echo "GROQ_API_KEY=your_groq_api_key" >> .env
# Run Streamlit app
streamlit run app.py