Skip to content

Commit 862085c

Browse files
committed
update documentation
1 parent c3c7a50 commit 862085c

12 files changed

Lines changed: 89 additions & 45 deletions

File tree

README.md

Lines changed: 83 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,58 @@
11
# **💼 TrueWealth AI: Your Smart Path to Financial Freedom**
2-
![Image](https://github.com/user-attachments/assets/4efaac48-4e70-49de-9dfa-f4e5802d31bb)
3-
## **Project Overview**
42

3+
[![Image](https://github.com/user-attachments/assets/4e411f0e-500a-4e8b-819a-8d6ccf701c3b)](https://github.com/user-attachments/assets/4e411f0e-500a-4e8b-819a-8d6ccf701c3b)
4+
5+
---
6+
7+
## Project Overview
58
**TrueWealth AI** is an advanced, AI-powered financial advisor that uses cutting-edge technologies in machine learning, natural language processing (NLP), and document retrieval. By leveraging advanced LLMs, real-time data access from financial tools like Yahoo Finance, DuckDuckGo, and dynamic document retrieval systems like LangChain and ChromaDB, it provides personalized financial advice. The system is designed to simulate a real-world financial advisor, offering clear, insightful, and actionable recommendations.
69

7-
### 🧱 Project Structure
10+
---
11+
12+
## 🚀 Live Demo
13+
14+
🎯 Try the real-time TrueWealth AI:
15+
👉 [**TrueWealth AI – Click Here**](https://truewealth-ai.onrender.com/)
16+
17+
---
18+
19+
## Real-World Use Cases
20+
21+
#### **1. Personal Financial Advisory**
22+
- Helps **individual investors** make informed decisions on stocks, bonds, and long-term investments.
23+
24+
#### **2. Financial Education & Self-Learning**
25+
- Acts as a **tutor** for users reading financial books (e.g., *The Intelligent Investor*).
26+
27+
#### **3. Real-Time Market & News Analysis**
28+
- Provides **up-to-date financial news** from Yahoo Finance.
29+
30+
#### **4. Small Business Financial Consulting**
31+
- Assists **small business owners** in budgeting, tax planning, and investment decisions.
32+
33+
#### **5. Retirement & Wealth Management**
34+
- Offers **retirement planning insights** (e.g., 401(k), Roth IRA strategies).
35+
36+
---
37+
38+
## **Features & Functionalities**
39+
40+
| ✅ Step | 🧠 Feature | ⚙️ Tech Stack / Tool Used |
41+
| ------ | ------------------------------------ | --------------------------------------------------------------- |
42+
| 1️⃣ | 🧠 **LLM-based Query Understanding** | **Groq** |
43+
| 2️⃣ |**Tone Personalization** | **Prompt Engineering** + **Persona Templates** |
44+
| 3️⃣ | 📚 **RAG-based Answering** | **LangChain** + **ChromaDB** + **Sentence Transformers** |
45+
| 4️⃣ | 🔍 **Retrieval Agent** | **RetrieverAgent** + **Vector Store Tools** |
46+
| 5️⃣ | 🧠 **Answer Generator Agent** | **GeneratorAgent** (LLM-based factual + human-style) |
47+
| 6️⃣ | 🧾 **Document QA Agent** | **DocumentReaderAgent** + **QA Chain** |
48+
| 7️⃣ | 🔁 **ToolRouter Agent** | **Conditional Logic** + **Tool Selection** |
49+
| 8️⃣ | 🧠 **Planner Agent** | **LangGraph Planner Node** |
50+
| 9️⃣ | 🔄 **Intelligent Tool Routing** | **Retry Logic** + **Fallback Tool** + **Score-based Selection** |
51+
| 🔟 | 🧠 **Short Conversational Memory** | **LangGraph Memory Integration (short-term)** |
52+
53+
---
54+
55+
## Project Structure
856
```
957
TrueWealth AI/
1058
├── streamlit_app.py # Streamlit-based user interface for financial advisor chatbot
@@ -50,35 +98,37 @@ TrueWealth AI/
5098
├── README.md # Project overview, setup instructions, features, architecture diagram
5199
```
52100

53-
54-
### **Tech Stack:**
55-
56-
* **LLMs (Large Language Models)**: **Groq**
57-
* **Data Retrieval**: **LangChain**, **ChromaDB**, **Sentence Transformers**
58-
* **Document Parsing**: **PyPDFLoader**, **DocumentReaderAgent**
59-
* **Search Tools**: **Yahoo Finance API**, **DuckDuckGo API**
60-
* **Memory Management**: **LangGraph Memory Integration**
61-
* **Agent Technique**: **ToolRouter Agent**, **Planner Agent**
62-
* **Backend**: **FastAPI** (for RESTful APIs)
63-
* **Frontend**: **Streamlit** (interactive UI)
64-
* **Deployment**: **Docker**, **CI/CD** (GitHub Actions/Jenkins)
65-
66101
---
67102

68-
## **Features & Functionalities**
69-
70-
| ✅ Step | 🧠 Feature | ⚙️ Tech Stack / Tool Used |
71-
| ------ | ------------------------------------ | --------------------------------------------------------------- |
72-
| 1️⃣ | 🧠 **LLM-based Query Understanding** | **Groq** |
73-
| 2️⃣ |**Tone Personalization** | **Prompt Engineering** + **Persona Templates** |
74-
| 3️⃣ | 📚 **RAG-based Answering** | **LangChain** + **ChromaDB** + **Sentence Transformers** |
75-
| 4️⃣ | 🔍 **Retrieval Agent** | **RetrieverAgent** + **Vector Store Tools** |
76-
| 5️⃣ | 🧠 **Answer Generator Agent** | **GeneratorAgent** (LLM-based factual + human-style) |
77-
| 6️⃣ | 🧾 **Document QA Agent** | **DocumentReaderAgent** + **QA Chain** |
78-
| 7️⃣ | 🔁 **ToolRouter Agent** | **Conditional Logic** + **Tool Selection** |
79-
| 8️⃣ | 🧠 **Planner Agent** | **LangGraph Planner Node** |
80-
| 9️⃣ | 🔄 **Intelligent Tool Routing** | **Retry Logic** + **Fallback Tool** + **Score-based Selection** |
81-
| 🔟 | 🧠 **Short Conversational Memory** | **LangGraph Memory Integration (short-term)** |
103+
## System Architecture
104+
105+
```mermaid
106+
flowchart TD
107+
A[User Query] --> B[Planner]
108+
B --> C[Recall Memory]
109+
C --> D[LLM Direct Answer Attempt]
110+
D -->|Success| E[Generate Response]
111+
D -->|Failure| F[Executor: Retry Logic]
112+
F --> G{Retry Count < 3?}
113+
G -->|Yes| H[RAG: Search PDF Knowledge]
114+
G -->|No| I[Yahoo Finance Search]
115+
H -->|Found Docs| E
116+
H -->|No Docs| I
117+
I -->|Found News| E
118+
I -->|No News| J[DuckDuckGo Web Search]
119+
J --> E
120+
E --> K[Store in Memory]
121+
K --> L[Return Final Answer]
122+
123+
%% External Tools
124+
H --> M[(ChromaDB)]
125+
I --> N[[Yahoo Finance]]
126+
J --> O[[DuckDuckGo]]
127+
128+
%% LLM Core
129+
D --> P[[Groq-LLaMA3]]
130+
E --> P
131+
```
82132

83133
---
84134

@@ -94,18 +144,6 @@ FastAPI serves as the backend for managing API requests, handling the communicat
94144

95145
---
96146

97-
## **User Interface with Streamlit**
98-
99-
Streamlit is used for the front-end, where users can interact with the financial advisor chatbot in a conversational format.
100-
101-
### **UI Features**:
102-
103-
* **Real-Time Interaction**: The Streamlit interface allows users to input queries and receive answers instantly.
104-
* **Tone Personalization**: Users can choose how formal or informal they want the assistant to sound.
105-
* **Live Data Display**: Financial data (such as stock prices, trends, and company news) is displayed dynamically.
106-
107-
---
108-
109147
## **Deployment Process with Docker**
110148

111149
### **Dockerization**:
@@ -147,12 +185,12 @@ Continuous Integration and Continuous Deployment (CI/CD) is implemented using **
147185

148186
---
149187

150-
### **Personal Information**
188+
## **Personal Information**
151189

152190
* **Developer:** Md Emon Hasan
153191
* **GitHub:** [Md-Emon-Hasan](https://github.com/Md-Emon-Hasan)
154-
* **LinkedIn:** [Md Emon Hasan](https://www.linkedin.com/in/md-emon-hasan)
192+
* **LinkedIn:** [Md Emon Hasan](https://www.linkedin.com/in/md-emon-hasan-695483237/)
155193
* **Email:** [iconicemon01@gmail.com](mailto:iconicemon01@gmail.com)
156194
* **WhatsApp:** [+8801834363533](https://wa.me/8801834363533)
157195

158-
---
196+
---

__pycache__/config.cpython-311.pyc

-338 Bytes
Binary file not shown.

__pycache__/logger.cpython-311.pyc

-677 Bytes
Binary file not shown.

app.png

209 KB
Loading

demo.webm

1.15 MB
Binary file not shown.
-1.6 MB
Binary file not shown.
-100 Bytes
Binary file not shown.
Binary file not shown.
-3.91 KB
Binary file not shown.
-8.42 KB
Binary file not shown.

0 commit comments

Comments
 (0)