globalnebula commited on
Commit
67869c9
·
verified ·
1 Parent(s): edfde39

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -159
README.md CHANGED
@@ -4,204 +4,110 @@ library_name: peft
4
  pipeline_tag: text-generation
5
  tags:
6
  - base_model:adapter:meta-llama/Meta-Llama-3-8B
 
7
  - lora
8
  - transformers
 
 
 
 
 
9
  ---
10
 
11
- # Model Card for Model ID
12
-
13
- <!-- Provide a quick summary of what the model is/does. -->
14
 
 
 
15
 
 
16
 
17
  ## Model Details
18
 
19
  ### Model Description
20
 
21
- <!-- Provide a longer summary of what this model is. -->
22
-
23
-
24
-
25
- - **Developed by:** [More Information Needed]
26
- - **Funded by [optional]:** [More Information Needed]
27
- - **Shared by [optional]:** [More Information Needed]
28
- - **Model type:** [More Information Needed]
29
- - **Language(s) (NLP):** [More Information Needed]
30
- - **License:** [More Information Needed]
31
- - **Finetuned from model [optional]:** [More Information Needed]
32
 
33
- ### Model Sources [optional]
 
 
 
 
 
 
34
 
35
- <!-- Provide the basic links for the model. -->
36
-
37
- - **Repository:** [More Information Needed]
38
- - **Paper [optional]:** [More Information Needed]
39
- - **Demo [optional]:** [More Information Needed]
40
 
41
  ## Uses
42
 
43
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
-
45
  ### Direct Use
46
 
47
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
-
49
- [More Information Needed]
50
-
51
- ### Downstream Use [optional]
52
 
53
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
54
 
55
- [More Information Needed]
 
 
56
 
57
  ### Out-of-Scope Use
58
 
59
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
 
60
 
61
- [More Information Needed]
62
 
63
  ## Bias, Risks, and Limitations
64
 
65
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
66
-
67
- [More Information Needed]
 
68
 
69
  ### Recommendations
70
 
71
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
72
-
73
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
74
-
75
- ## How to Get Started with the Model
76
-
77
- Use the code below to get started with the model.
78
 
79
- [More Information Needed]
80
 
81
  ## Training Details
82
 
83
  ### Training Data
84
 
85
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
 
 
 
86
 
87
- [More Information Needed]
88
 
89
  ### Training Procedure
90
 
91
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
92
-
93
- #### Preprocessing [optional]
94
-
95
- [More Information Needed]
96
-
97
 
98
  #### Training Hyperparameters
99
-
100
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
101
-
102
- #### Speeds, Sizes, Times [optional]
103
-
104
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
105
-
106
- [More Information Needed]
107
-
108
- ## Evaluation
109
-
110
- <!-- This section describes the evaluation protocols and provides the results. -->
111
-
112
- ### Testing Data, Factors & Metrics
113
-
114
- #### Testing Data
115
-
116
- <!-- This should link to a Dataset Card if possible. -->
117
-
118
- [More Information Needed]
119
-
120
- #### Factors
121
-
122
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
123
-
124
- [More Information Needed]
125
-
126
- #### Metrics
127
-
128
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
129
-
130
- [More Information Needed]
131
-
132
- ### Results
133
-
134
- [More Information Needed]
135
-
136
- #### Summary
137
-
138
-
139
-
140
- ## Model Examination [optional]
141
-
142
- <!-- Relevant interpretability work for the model goes here -->
143
-
144
- [More Information Needed]
145
-
146
- ## Environmental Impact
147
-
148
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
149
-
150
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
151
-
152
- - **Hardware Type:** [More Information Needed]
153
- - **Hours used:** [More Information Needed]
154
- - **Cloud Provider:** [More Information Needed]
155
- - **Compute Region:** [More Information Needed]
156
- - **Carbon Emitted:** [More Information Needed]
157
-
158
- ## Technical Specifications [optional]
159
-
160
- ### Model Architecture and Objective
161
-
162
- [More Information Needed]
163
-
164
- ### Compute Infrastructure
165
-
166
- [More Information Needed]
167
-
168
- #### Hardware
169
-
170
- [More Information Needed]
171
-
172
- #### Software
173
-
174
- [More Information Needed]
175
-
176
- ## Citation [optional]
177
-
178
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
179
-
180
- **BibTeX:**
181
-
182
- [More Information Needed]
183
-
184
- **APA:**
185
-
186
- [More Information Needed]
187
-
188
- ## Glossary [optional]
189
-
190
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
191
-
192
- [More Information Needed]
193
-
194
- ## More Information [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Authors [optional]
199
-
200
- [More Information Needed]
201
-
202
- ## Model Card Contact
203
-
204
- [More Information Needed]
205
- ### Framework versions
206
-
207
- - PEFT 0.17.1
 
4
  pipeline_tag: text-generation
5
  tags:
6
  - base_model:adapter:meta-llama/Meta-Llama-3-8B
7
+ - finoai
8
  - lora
9
  - transformers
10
+ - financial-analysis
11
+ - privacy-ai
12
+ license: mit
13
+ language:
14
+ - en
15
  ---
16
 
17
+ # Model Card for FinoAI — Financial Intelligence LLM
 
 
18
 
19
+ FinoAI is a privacy-first, explainable financial reasoning model fine-tuned on the Meta-Llama-3-8B base using parameter-efficient fine-tuning (PEFT) and LoRA adapters.
20
+ It acts as a secure, autonomous AI financial advisor capable of forecasting, anomaly detection, and policy-grounded recommendations across personal and enterprise finance contexts.
21
 
22
+ ---
23
 
24
  ## Model Details
25
 
26
  ### Model Description
27
 
28
+ FinoAI is a hybrid AI model that integrates Graph Neural Ordinary Differential Equations (GNN-ODEs) with a multi-stage Large Language Model reasoning pipeline (Planner → Executor → Fact-Guard).
29
+ The model performs continuous-time financial forecasting, investment planning, and anomaly detection while maintaining user privacy through federated learning and differential privacy mechanisms.
30
+ It is designed for both consumer (B2C) and enterprise (B2B) deployment scenarios, supporting API, web, and voice-based interfaces.
 
 
 
 
 
 
 
 
31
 
32
+ - **Developed by:** S Kunal Achintya Reddy
33
+ - **Model Type:** Financial reasoning and forecasting LLM
34
+ - **Languages:** English
35
+ - **License:** MIT
36
+ - **Fine-tuned from model:** meta-llama/Meta-Llama-3-8B
37
+ - **Frameworks:** PyTorch, PEFT, Hugging Face Transformers, LangChain
38
+ - **Version:** 1.0 (October 2025)
39
 
 
 
 
 
 
40
 
41
  ## Uses
42
 
 
 
43
  ### Direct Use
44
 
45
+ FinoAI can be used directly for:
46
+ - Personalized financial advisory and planning
47
+ - Debt optimization and anomaly detection
48
+ - Investment forecasting and policy compliance queries
49
+ - Conversational financial assistants or embedded fintech copilots
50
 
51
+ ### Downstream Use
52
 
53
+ - Finetuning or domain adaptation for specific markets (e.g., insurance, SME credit scoring)
54
+ - Embedding as a reasoning layer in enterprise fintech dashboards
55
+ - Integration with federated finance apps requiring privacy guarantees
56
 
57
  ### Out-of-Scope Use
58
 
59
+ - Licensed financial advice without human review
60
+ - Predictive trading or speculative financial activities
61
+ - Processing personally identifiable financial data without consent
62
 
63
+ ---
64
 
65
  ## Bias, Risks, and Limitations
66
 
67
+ - FinoAI’s outputs depend on data quality and may reflect inaccuracies in the financial documents used for training.
68
+ - The model is not a certified financial advisor and should be used as a decision-support tool.
69
+ - While differential privacy mitigates leakage risk, outputs should not be used for regulated decision-making without compliance oversight.
70
+ - Model performance may degrade in underrepresented financial systems or local languages.
71
 
72
  ### Recommendations
73
 
74
+ Users and developers should:
75
+ - Use the model for advisory and educational purposes, not regulatory or transactional decision-making.
76
+ - Ensure interpretability modules (Fact-Guard and RAG explainability) remain active during deployment.
77
+ - Periodically retrain with updated financial datasets to avoid model drift.
 
 
 
78
 
79
+ ---
80
 
81
  ## Training Details
82
 
83
  ### Training Data
84
 
85
+ The model was trained on a curated proprietary dataset of:
86
+ - Publicly available financial documents (RBI guidelines, SEBI reports, OECD datasets)
87
+ - Educational finance materials (tax codes, investment fundamentals, risk management data)
88
+ - Synthetic dialogues and case studies generated using reinforcement-based reasoning for advisor simulation
89
 
90
+ Data was curated using a **custom financial web crawler** built for regulatory document scraping and normalization.
91
 
92
  ### Training Procedure
93
 
94
+ #### Preprocessing
95
+ - Data cleaned, tokenized, and formatted into structured “context → reasoning → insight” triplets.
96
+ - Outliers filtered using statistical anomaly detection.
97
+ - Financial equations standardized using symbolic formatting.
 
 
98
 
99
  #### Training Hyperparameters
100
+ - **Base model:** Meta-Llama-3-8B
101
+ - **Fine-tuning:** LoRA (r=32, alpha=16)
102
+ - **Batch size:** 64
103
+ - **Learning rate:** 2e-4
104
+ - **Optimizer:** AdamW
105
+ - **Precision:** bf16 mixed precision
106
+ - **Epochs:** 5
107
+ - **Training cost:** 9.28 USD (RunPod A100, 6.2 GPU-hours)
108
+
109
+ #### Speeds, Sizes, Times
110
+ - Total parameters (trainable): ~120M
111
+ - Checkpoint size: ~2.5 GB
112
+ - Average training speed: 420 tokens/sec
113
+ - Total training time: ~6 hours