Update README.md
Browse files
README.md
CHANGED
|
@@ -12,3 +12,75 @@ short_description: Simple project for Gita Assistance
|
|
| 12 |
---
|
| 13 |
|
| 14 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
---
|
| 13 |
|
| 14 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
| 15 |
+
|
| 16 |
+
|
| 17 |
+
Of course, Arjun! Here's an updated `README.md` tailored specifically for your Hugging Face Space: [parjun/Gita_Assistant_Langchain_project](https://huggingface.co/spaces/parjun/Gita_Assistant_Langchain_project/tree/main). It reflects the spiritual intent, technical stack, and usage flow of your LangChain-powered Gita chatbot:
|
| 18 |
+
|
| 19 |
+
---
|
| 20 |
+
|
| 21 |
+
# 🕉️ Gita Assistant — LangChain Project
|
| 22 |
+
|
| 23 |
+
A conversational AI chatbot built with **Gradio**, **LangChain**, and powered by **Groq’s gemma2-9b-it** model. This assistant is designed to offer thoughtful, spiritually grounded responses inspired by the **Bhagavad Gita**, while supporting general-purpose Q&A.
|
| 24 |
+
|
| 25 |
+
## 🌿 Overview
|
| 26 |
+
|
| 27 |
+
This chatbot is initialized with a **spiritual system role**:
|
| 28 |
+
> “You are a Spiritual Gita AI assistant”
|
| 29 |
+
|
| 30 |
+
It responds to user queries with philosophical depth, contextual awareness, and a calm, devotional tone. Ideal for seekers, learners, and anyone curious about Gita wisdom.
|
| 31 |
+
|
| 32 |
+
## ✨ Features
|
| 33 |
+
|
| 34 |
+
- 🧘 Gita-inspired assistant persona
|
| 35 |
+
- 🔁 Multi-turn conversation memory
|
| 36 |
+
- 🔐 Secure API key input via Gradio textbox
|
| 37 |
+
- 📜 Expandable chat history with role-based formatting
|
| 38 |
+
- ⚡ Powered by Groq’s `gemma2-9b-it` via LangChain
|
| 39 |
+
- 🌐 Hosted on Hugging Face Spaces
|
| 40 |
+
|
| 41 |
+
## 🛠️ Tech Stack
|
| 42 |
+
|
| 43 |
+
| Component | Purpose |
|
| 44 |
+
|------------------|----------------------------------------------|
|
| 45 |
+
| Gradio | Web interface for interactive chatbot |
|
| 46 |
+
| LangChain | Message abstraction and session flow |
|
| 47 |
+
| langchain-groq | Groq API integration with Gemma model |
|
| 48 |
+
| Python dotenv | (Optional) local development key loading |
|
| 49 |
+
|
| 50 |
+
## 🚀 How to Use
|
| 51 |
+
|
| 52 |
+
1. Enter your **Groq API key** in the input box
|
| 53 |
+
2. Ask a question — spiritual, philosophical, or general
|
| 54 |
+
3. View the AI’s response and full conversation history
|
| 55 |
+
4. Reflect, explore, or customize the assistant’s role
|
| 56 |
+
|
| 57 |
+
## 📦 Local Setup (Optional)
|
| 58 |
+
|
| 59 |
+
```bash
|
| 60 |
+
git clone https://huggingface.co/spaces/parjun/Gita_Assistant_Langchain_project
|
| 61 |
+
cd Gita_Assistant_Langchain_project
|
| 62 |
+
pip install -r requirements.txt
|
| 63 |
+
python app.py
|
| 64 |
+
```
|
| 65 |
+
|
| 66 |
+
## 📚 Chat History Format
|
| 67 |
+
|
| 68 |
+
- ⚙️ *System Role* — defines assistant’s personality
|
| 69 |
+
- 👤 **User** — your questions and prompts
|
| 70 |
+
- 🤖 **Bot** — AI-generated responses
|
| 71 |
+
|
| 72 |
+
## 🧪 Customization Ideas
|
| 73 |
+
|
| 74 |
+
- 🔄 Add persona switcher (e.g. “Guru”, “Comedian”, “Therapist”)
|
| 75 |
+
- 📖 Integrate Gita verse embeddings for retrieval-augmented answers
|
| 76 |
+
- 🔊 Add TTS for voice-based spiritual guidance
|
| 77 |
+
- 🧠 Extend with LangChain tools or memory modules
|
| 78 |
+
|
| 79 |
+
## 📄 License
|
| 80 |
+
|
| 81 |
+
Open-source under [MIT License](https://opensource.org/licenses/MIT)
|
| 82 |
+
|
| 83 |
+
---
|
| 84 |
+
|
| 85 |
+
Would you like me to help you add a `SpaceCard` with emoji tags and a short description for Hugging Face discoverability? I can also scaffold a `requirements.txt` or modularize the persona logic if you're planning to expand it.
|
| 86 |
+
|