ayush2917 commited on
Commit
4f8e457
·
verified ·
1 Parent(s): 2b4ef1b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +18 -16
README.md CHANGED
@@ -1,36 +1,38 @@
1
  ---
2
  title: Rupeia Financial Assistant
3
  emoji: 💰
4
- colorFrom: blue
5
- colorTo: green
6
  sdk: docker
7
- sdk_version: "1.0.0"
8
  app_file: app.py
9
  pinned: true
 
10
  ---
11
 
12
  # Rupeia Financial Support Chatbot
13
 
14
- ![Chatbot Demo](static/demo.gif) *Example interaction with Rupeia chatbot*
15
 
16
- An intelligent financial assistant for Rupeia investment platform, featuring:
17
- - **Context-aware responses** using Hugging Face Transformers
18
- - **Simplified RAG** with in-memory cosine similarity search
19
- - **Multi-topic support**: Investments, Savings Goals, Benefits, and more
20
 
21
- ## 🛠 Installation
22
 
23
  ### Local Development
24
  ```bash
25
- # 1. Clone and setup
26
- git clone https://github.com/your-repo/rupeia-chatbot.git
27
- cd rupeia-chatbot
28
 
29
- # 2. Install dependencies
 
 
 
 
30
  pip install -r requirements.txt
31
 
32
- # 3. Configure (copy and edit the example config)
33
  cp config/config.example.yaml config/config.yaml
34
 
35
- # 4. Launch
36
- python app.py
 
1
  ---
2
  title: Rupeia Financial Assistant
3
  emoji: 💰
4
+ colorFrom: indigo
5
+ colorTo: blue
6
  sdk: docker
7
+ sdk_version: "2.2.0"
8
  app_file: app.py
9
  pinned: true
10
+ license: mit
11
  ---
12
 
13
  # Rupeia Financial Support Chatbot
14
 
15
+ ![Chatbot Workflow](static/workflow.png)
16
 
17
+ An intelligent financial assistant providing real-time support for investment queries, powered by Flask and Hugging Face Transformers with optimized RAG architecture.
 
 
 
18
 
19
+ ## 🚀 Quick Installation
20
 
21
  ### Local Development
22
  ```bash
23
+ # 1. Clone repository
24
+ git clone https://github.com/rupeia/chatbot.git
25
+ cd chatbot
26
 
27
+ # 2. Setup environment (Python 3.9+ required)
28
+ python -m venv .venv
29
+ source .venv/bin/activate # Windows: .venv\Scripts\activate
30
+
31
+ # 3. Install dependencies
32
  pip install -r requirements.txt
33
 
34
+ # 4. Configure (edit model paths as needed)
35
  cp config/config.example.yaml config/config.yaml
36
 
37
+ # 5. Launch development server
38
+ flask run --port 8000