changed readme file

README.md

@@ -1,7 +1,48 @@
-# RAG
+---
+title: ScholarBot
+emoji: 📚
+colorFrom: indigo
+colorTo: blue
+sdk: streamlit
+sdk_version: "1.35.0"
+python_version: "3.10"
+app_file: app.py
+suggested_hardware: cpu-basic
+suggested_storage: medium
+fullWidth: true
+header: default
+short_description: "Upload research papers and chat with them using RAG and LLMs."
+tags:
+  - rag
+  - langchain
+  - streamlit
+  - chatbot
+  - document-qa
+  - ai-research
+  - huggingface
+  - vector-database
+pinned: true
+---
 
-## What should be the input format?
-* Extract text from pdf?
-* Use .tex file in submission?
-##### The latex format might not be very good for the LLM (specially when it is a smaller LLM). So, extracting text from pdf would be better. 
-we could bring it latex if the output doesn't seem to be good enough. Or we are missing out the mathematical equations.
+# 🤖 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

requirements.txt

@@ -0,0 +1,10 @@
+langchain>=0.1.14
+langchain-groq>=0.0.3
+langchain-community>=0.0.26
+chromadb>=0.4.24
+sentence-transformers>=2.2.2
+pypdf>=3.9.1
+streamlit>=1.34.0
+python-dotenv>=1.0.1
+PyYAML>=6.0.1
+requests>=2.31.0