shravankotagi commited on
Commit
dfe6dfe
·
verified ·
1 Parent(s): 3178449

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -29
README.md CHANGED
@@ -27,54 +27,54 @@ language:
27
  [![Dataset](https://img.shields.io/badge/Dataset-Hinglish_Finance_SFT-yellow)](https://huggingface.co/datasets/shravankotagi/hinglish-finance-sft-v5-fixed)
28
  [![PEFT](https://img.shields.io/badge/Adapter-PEFT_LoRA-orange)](https://github.com/huggingface/peft)
29
 
30
- A QLoRA fine-tune of **Sarvam-1** underlying **SmartVest**, an interactive web application designed for Indian retail investors[cite: 8]. SmartVest allows users to text or speak their financial, tax, and trading queries in conversational **Hinglish** (Hindi in Latin script mixed with English financial terms) and receive real-time, safety-verified responses[cite: 8].
31
 
32
  ---
33
 
34
  ## 📱 SmartVest Interactive Interface
35
 
36
- SmartVest is deployed as a full-stack financial assistant with an integrated safety verification engine[cite: 8]:
37
 
38
- - **Voice & Text Input:** Users can type or use voice queries (speech-to-text) to ask market questions[cite: 8].
39
- - **Trust Guard Panel:** Features real-time LLM response validation, evaluating outputs against safety checkpoints (e.g., SEBI disclaimers, hallucination checks) to assign a verification score before rendering to the user[cite: 8].
40
- - **Conversational Search History:** Tracks query logs and verification statuses (`PASS`) in real time[cite: 8].
41
 
42
  ---
43
 
44
  ## 💬 Sample Generation Outputs
45
 
46
  ### Example 1: Live Market & Entity Query
47
- **User:** `Bajaj Housing Finance ka aaj ka bhav kya hai?`[cite: 8]
48
- **SmartVest:** `Bajaj Housing Finance (BAJAJHFL) ka aaj ka live NSE price hai Rs 86.52 (change neeche -1.27% aaj). Invest karne se pehle apne broker app pe confirm karein. Yeh sirf informational data hai. SEBI registered advisor se zaroor milein.`[cite: 8]
49
 
50
  ### Example 2: Portfolio Advice & Risk Query
51
- **User:** `loss ho raha hai portfolio mein kya karein?`[cite: 8]
52
- **SmartVest:** `Bear market mein ghabrana zaroori nahi. Historically markets hamesha recover karte hain - long term investors ke liye yeh buying opportunity hoti hai. SIP jaari rakho, quality stocks hold karo, panic mein mat becho. Yeh sirf educational info hai. SEBI registered advisor se zaroor milein.`[cite: 8]
53
 
54
  ### Example 3: Financial Product Comparison
55
- **User:** `FD vs mutual fund konsa better hai long term ke liye?`[cite: 8]
56
- **SmartVest:** `FD (Fixed Deposit) mein guaranteed returns milte hain aur risk bahut low hota hai, jabki Mutual Funds market-linked hote hain aur unme high returns ka potential hota hai. Long term wealth creation ke liye Mutual Funds behtar hain, par short term safety ke liye FD secure hai. Apne goal ke hisab se allocate karein. Yeh sirf educational info hai. SEBI registered advisor se zaroor milein.`[cite: 8]
57
 
58
  ---
59
 
60
  ## Model Details
61
 
62
- - **Developed by:** Shravan Kotagi[cite: 8]
63
- - **Application Name:** SmartVest[cite: 8]
64
- - **Model type:** Causal LM — Sarvam-1 + LoRA adapter (PEFT)[cite: 8]
65
- - **Languages:** Hinglish (hi-Latn), English[cite: 8]
66
- - **License:** Apache 2.0[cite: 8]
67
- - **Base model:** `sarvamai/sarvam-1`[cite: 8]
68
- - **Task:** Conversational SFT for Indian finance, tax rules (LTCG/STCG), stock tickers, and general market literacy[cite: 8].
69
 
70
  ---
71
 
72
  ## What It Does
73
 
74
- SmartVest acts as a friendly, concise AI assistant for Indian stock market queries[cite: 8]:
75
- - **Entity Resolution:** Handles Indian tickers (e.g., `BAJAJHFL`, `RELIANCE`, `INFY`) and Hinglish financial slang (`bhav`, `mandi`, `munafa`, `profit book`)[cite: 8].
76
- - **Taxation & Market Literacy:** Explains capital gains tax, brokerage charges, and trading losses clearly[cite: 8].
77
- - **Safety Disclaimers & Trust Guard:** Automatically includes SEBI/educational disclaimers and verifies responses for investor safety[cite: 8].
78
 
79
  ---
80
 
@@ -85,8 +85,7 @@ SmartVest acts as a friendly, concise AI assistant for Indian stock market queri
85
  | **Base Model** | `sarvamai/sarvam-1` |
86
  | **Method** | QLoRA (4-bit quantization via `bitsandbytes`) |
87
  | **Dataset** | [`shravankotagi/hinglish-finance-sft-v5-fixed`](https://huggingface.co/datasets/shravankotagi/hinglish-finance-sft-v5-fixed) |
88
- | **Train / Val Split** | 4,696 train / 825 validation examples |
89
- | **Hardware** | Kaggle GPU |
90
  | **LoRA Rank / Alpha** | `r=16` / `alpha=32` (`dropout=0.05`) |
91
  | **Target Modules** | `q_proj`, `k_proj`, `v_proj`, `o_proj`, `gate_proj`, `up_proj`, `down_proj` |
92
  | **Trainable Parameters** | 23,969,792 / 2,549,463,040 (0.94%) |
@@ -95,10 +94,10 @@ SmartVest acts as a friendly, concise AI assistant for Indian stock market queri
95
  | **Optimizer / LR** | `paged_adamw_8bit` / `1e-4` (Cosine Scheduler) |
96
 
97
  ### Dataset Overview
98
- The model was fine-tuned on [`shravankotagi/hinglish-finance-sft-v5-fixed`](https://huggingface.co/datasets/shravankotagi/hinglish-finance-sft-v5-fixed), an instruction dataset consisting of 5,521 instruction-response pairs covering[cite: 8]:
99
- - **Financial QA & Literacy:** Mutual funds, ETFs, portfolio rebalancing, and risk metrics[cite: 8].
100
- - **Indian Taxation:** Capital gains (LTCG/STCG), ITR forms, and tax loss harvesting[cite: 8].
101
- - **Market Sentiment & News:** Analysis of market trends, corporate actions, and regulatory updates in conversational Hinglish[cite: 8].
102
 
103
  ---
104
 
@@ -118,7 +117,7 @@ The model was fine-tuned on [`shravankotagi/hinglish-finance-sft-v5-fixed`](http
118
 
119
  ## How to Use
120
 
121
- To run inference, load `sarvamai/sarvam-1` in 4-bit mode, resize its embedding layer to match the expanded tokenizer, and apply the PEFT adapter[cite: 8]:
122
 
123
  ```python
124
  import torch
 
27
  [![Dataset](https://img.shields.io/badge/Dataset-Hinglish_Finance_SFT-yellow)](https://huggingface.co/datasets/shravankotagi/hinglish-finance-sft-v5-fixed)
28
  [![PEFT](https://img.shields.io/badge/Adapter-PEFT_LoRA-orange)](https://github.com/huggingface/peft)
29
 
30
+ A QLoRA fine-tune of **Sarvam-1** underlying **SmartVest**, an interactive web application designed for Indian retail investors. SmartVest allows users to text or speak their financial, tax, and trading queries in conversational **Hinglish** (Hindi in Latin script mixed with English financial terms) and receive real-time, safety-verified responses.
31
 
32
  ---
33
 
34
  ## 📱 SmartVest Interactive Interface
35
 
36
+ SmartVest is deployed as a full-stack financial assistant with an integrated safety verification engine:
37
 
38
+ - **Voice & Text Input:** Users can type or use voice queries (speech-to-text) to ask market questions.
39
+ - **Trust Guard Panel:** Features real-time LLM response validation, evaluating outputs against safety checkpoints (e.g., SEBI disclaimers, hallucination checks) to assign a verification score before rendering to the user.
40
+ - **Conversational Search History:** Tracks query logs and verification statuses (`PASS`) in real time.
41
 
42
  ---
43
 
44
  ## 💬 Sample Generation Outputs
45
 
46
  ### Example 1: Live Market & Entity Query
47
+ **User:** `Bajaj Housing Finance ka aaj ka bhav kya hai?`
48
+ **SmartVest:** `Bajaj Housing Finance (BAJAJHFL) ka aaj ka live NSE price hai Rs 86.52 (change neeche -1.27% aaj). Invest karne se pehle apne broker app pe confirm karein. Yeh sirf informational data hai. SEBI registered advisor se zaroor milein.`
49
 
50
  ### Example 2: Portfolio Advice & Risk Query
51
+ **User:** `loss ho raha hai portfolio mein kya karein?`
52
+ **SmartVest:** `Bear market mein ghabrana zaroori nahi. Historically markets hamesha recover karte hain - long term investors ke liye yeh buying opportunity hoti hai. SIP jaari rakho, quality stocks hold karo, panic mein mat becho. Yeh sirf educational info hai. SEBI registered advisor se zaroor milein.`
53
 
54
  ### Example 3: Financial Product Comparison
55
+ **User:** `FD vs mutual fund konsa better hai long term ke liye?`
56
+ **SmartVest:** `FD (Fixed Deposit) mein guaranteed returns milte hain aur risk bahut low hota hai, jabki Mutual Funds market-linked hote hain aur unme high returns ka potential hota hai. Long term wealth creation ke liye Mutual Funds behtar hain, par short term safety ke liye FD secure hai. Apne goal ke hisab se allocate karein. Yeh sirf educational info hai. SEBI registered advisor se zaroor milein.`
57
 
58
  ---
59
 
60
  ## Model Details
61
 
62
+ - **Developed by:** Shravan Kotagi
63
+ - **Application Name:** SmartVest
64
+ - **Model type:** Causal LM — Sarvam-1 + LoRA adapter (PEFT)
65
+ - **Languages:** Hinglish (hi-Latn), English
66
+ - **License:** Apache 2.0
67
+ - **Base model:** `sarvamai/sarvam-1`
68
+ - **Task:** Conversational SFT for Indian finance, tax rules (LTCG/STCG), stock tickers, and general market literacy.
69
 
70
  ---
71
 
72
  ## What It Does
73
 
74
+ SmartVest acts as a friendly, concise AI assistant for Indian stock market queries:
75
+ - **Entity Resolution:** Handles Indian tickers (e.g., `BAJAJHFL`, `RELIANCE`, `INFY`) and Hinglish financial slang (`bhav`, `mandi`, `munafa`, `profit book`).
76
+ - **Taxation & Market Literacy:** Explains capital gains tax, brokerage charges, and trading losses clearly.
77
+ - **Safety Disclaimers & Trust Guard:** Automatically includes SEBI/educational disclaimers and verifies responses for investor safety.
78
 
79
  ---
80
 
 
85
  | **Base Model** | `sarvamai/sarvam-1` |
86
  | **Method** | QLoRA (4-bit quantization via `bitsandbytes`) |
87
  | **Dataset** | [`shravankotagi/hinglish-finance-sft-v5-fixed`](https://huggingface.co/datasets/shravankotagi/hinglish-finance-sft-v5-fixed) |
88
+ | **Hardware** | Kaggle T4 GPU (15.6 GB VRAM) |
 
89
  | **LoRA Rank / Alpha** | `r=16` / `alpha=32` (`dropout=0.05`) |
90
  | **Target Modules** | `q_proj`, `k_proj`, `v_proj`, `o_proj`, `gate_proj`, `up_proj`, `down_proj` |
91
  | **Trainable Parameters** | 23,969,792 / 2,549,463,040 (0.94%) |
 
94
  | **Optimizer / LR** | `paged_adamw_8bit` / `1e-4` (Cosine Scheduler) |
95
 
96
  ### Dataset Overview
97
+ The model was fine-tuned on [`shravankotagi/hinglish-finance-sft-v5-fixed`](https://huggingface.co/datasets/shravankotagi/hinglish-finance-sft-v5-fixed), an instruction dataset consisting of 5,521 instruction-response pairs covering:
98
+ - **Financial QA & Literacy:** Mutual funds, ETFs, portfolio rebalancing, and risk metrics.
99
+ - **Indian Taxation:** Capital gains (LTCG/STCG), ITR forms, and tax loss harvesting.
100
+ - **Market Sentiment & News:** Analysis of market trends, corporate actions, and regulatory updates in conversational Hinglish.
101
 
102
  ---
103
 
 
117
 
118
  ## How to Use
119
 
120
+ To run inference, load `sarvamai/sarvam-1` in 4-bit mode, resize its embedding layer to match the expanded tokenizer, and apply the PEFT adapter:
121
 
122
  ```python
123
  import torch