Raahulthakur commited on
Commit
354020c
ยท
verified ยท
1 Parent(s): 718c1b5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -14
README.md CHANGED
@@ -10,15 +10,15 @@ license: apache-2.0
10
  short_description: Multi-agent AI assistant for finance, news, and analysis.
11
  ---
12
 
13
- # ๐Ÿ“Š FinSightX โ€“ AI-Powered Financial Analyst Suite
14
 
15
  **FinSightX** is an intelligent, agent-powered financial assistant built using Groq's ultra-fast LLaMA 3.1 models, AutoRAG, and open-source tools. It allows users to query equities, summarize news, run macroeconomic forecasts, test quant strategies, track regulatory changes, and receive client-style advisory responses โ€” all in one lightweight app.
16
 
17
- > ๐Ÿ’ก Built with Groq API, Hugging Face Transformers, ChromaDB, and Streamlit.
18
 
19
  ---
20
 
21
- ## ๐Ÿš€ Features
22
 
23
  | Agent | Role |
24
  |-------|------|
@@ -31,7 +31,7 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
31
 
32
  ---
33
 
34
- ## ๐Ÿ› ๏ธ Tech Stack
35
 
36
  - **LLM**: `llama-3.1-8b-instant` via Groq API (OpenAI-compatible)
37
  - **Embedding**: `all-MiniLM-L6-v2` (SentenceTransformers)
@@ -43,7 +43,7 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
43
 
44
  ---
45
 
46
- ## โš™๏ธ Setup Instructions
47
 
48
  1. Clone the repo
49
  2. Install dependencies:
@@ -60,7 +60,7 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
60
  streamlit run ui/streamlit_app.py
61
  ```
62
 
63
- ## ๐Ÿ“‰ Current Limitations
64
 
65
  - ChromaDB does not yet include 10-K/10-Q or earnings data
66
  - Macro indicators (CPI, interest rates) not integrated
@@ -70,9 +70,9 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
70
 
71
  ---
72
 
73
- ## ๐Ÿ“‚ Future Improvements
74
 
75
- ### ๐Ÿ“„ Financial Documents to Integrate
76
 
77
  | Document | Use |
78
  |------------------------------|-----------------------------------------------|
@@ -82,7 +82,7 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
82
  | Investor Presentations | Visual and forward-looking insights |
83
  | Proxy Statements (DEF 14A) | Governance and voting info |
84
 
85
- ### ๐Ÿ“Š Financial Metrics to Add
86
 
87
  - Free cash flow
88
  - ROE / ROIC
@@ -90,7 +90,7 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
90
  - Piotroski F-Score
91
  - Debt/equity & profitability ratios
92
 
93
- ### ๐ŸŒ Macroeconomic Indicators
94
 
95
  | Indicator | Source |
96
  |--------------------------|------------------------------------|
@@ -98,7 +98,7 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
98
  | Fed rates, Inflation | TradingEconomics / OpenBB |
99
  | Currency / Commodities | Yahoo Finance / forex-python |
100
 
101
- ### ๐Ÿ”Œ Tools & Libraries to Integrate
102
 
103
  - `sec-api.io` or `sec-edgar-downloader` (for 10-Ks)
104
  - `openbb` (for macro + financial aggregation)
@@ -107,7 +107,7 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
107
 
108
  ---
109
 
110
- ## ๐Ÿ”ฎ Future Agent Extensions
111
 
112
  | Agent Name | Description |
113
  |------------------------|------------------------------------------------------------------------|
@@ -117,14 +117,14 @@ short_description: Multi-agent AI assistant for finance, news, and analysis.
117
 
118
  ---
119
 
120
- ## ๐Ÿ“˜ License
121
 
122
  Currently for **research and educational purposes only**.
123
  If using Groq-hosted LLaMA 3.1, ensure compliance with Metaโ€™s licensing.
124
 
125
  ---
126
 
127
- ## ๐Ÿ‘จโ€๐Ÿ’ป Author
128
 
129
  Developed by **Rahul Thakur**
130
  Want to collaborate or contribute? Fork, star, and connect!
 
10
  short_description: Multi-agent AI assistant for finance, news, and analysis.
11
  ---
12
 
13
+ # FinSightX โ€“ AI-Powered Financial Analyst Suite
14
 
15
  **FinSightX** is an intelligent, agent-powered financial assistant built using Groq's ultra-fast LLaMA 3.1 models, AutoRAG, and open-source tools. It allows users to query equities, summarize news, run macroeconomic forecasts, test quant strategies, track regulatory changes, and receive client-style advisory responses โ€” all in one lightweight app.
16
 
17
+ > Built with Groq API, Hugging Face Transformers, ChromaDB, and Streamlit.
18
 
19
  ---
20
 
21
+ ## Features
22
 
23
  | Agent | Role |
24
  |-------|------|
 
31
 
32
  ---
33
 
34
+ ## Tech Stack
35
 
36
  - **LLM**: `llama-3.1-8b-instant` via Groq API (OpenAI-compatible)
37
  - **Embedding**: `all-MiniLM-L6-v2` (SentenceTransformers)
 
43
 
44
  ---
45
 
46
+ ## Setup Instructions
47
 
48
  1. Clone the repo
49
  2. Install dependencies:
 
60
  streamlit run ui/streamlit_app.py
61
  ```
62
 
63
+ ## Current Limitations
64
 
65
  - ChromaDB does not yet include 10-K/10-Q or earnings data
66
  - Macro indicators (CPI, interest rates) not integrated
 
70
 
71
  ---
72
 
73
+ ## Future Improvements
74
 
75
+ ### Financial Documents to Integrate
76
 
77
  | Document | Use |
78
  |------------------------------|-----------------------------------------------|
 
82
  | Investor Presentations | Visual and forward-looking insights |
83
  | Proxy Statements (DEF 14A) | Governance and voting info |
84
 
85
+ ### Financial Metrics to Add
86
 
87
  - Free cash flow
88
  - ROE / ROIC
 
90
  - Piotroski F-Score
91
  - Debt/equity & profitability ratios
92
 
93
+ ### Macroeconomic Indicators
94
 
95
  | Indicator | Source |
96
  |--------------------------|------------------------------------|
 
98
  | Fed rates, Inflation | TradingEconomics / OpenBB |
99
  | Currency / Commodities | Yahoo Finance / forex-python |
100
 
101
+ ### Tools & Libraries to Integrate
102
 
103
  - `sec-api.io` or `sec-edgar-downloader` (for 10-Ks)
104
  - `openbb` (for macro + financial aggregation)
 
107
 
108
  ---
109
 
110
+ ## Future Agent Extensions
111
 
112
  | Agent Name | Description |
113
  |------------------------|------------------------------------------------------------------------|
 
117
 
118
  ---
119
 
120
+ ## License
121
 
122
  Currently for **research and educational purposes only**.
123
  If using Groq-hosted LLaMA 3.1, ensure compliance with Metaโ€™s licensing.
124
 
125
  ---
126
 
127
+ ## Author
128
 
129
  Developed by **Rahul Thakur**
130
  Want to collaborate or contribute? Fork, star, and connect!