Rustamshry commited on
Commit
bf25dc4
·
verified ·
1 Parent(s): 9f4df37

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +76 -164
README.md CHANGED
@@ -1,199 +1,111 @@
1
  ---
2
  library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
  # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
 
 
 
 
 
10
 
11
 
12
- ## Model Details
13
-
14
  ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
  ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
  ### Direct Use
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
 
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
 
58
  ## Bias, Risks, and Limitations
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
 
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
 
70
  ## How to Get Started with the Model
71
 
72
  Use the code below to get started with the model.
73
 
74
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
75
 
76
  ## Training Details
77
 
78
  ### Training Data
79
 
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
 
197
- ## Model Card Contact
 
 
198
 
199
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ tags:
4
+ - unsloth
5
+ - sft
6
+ - reasoning
7
+ license: apache-2.0
8
+ datasets:
9
+ - Akhil-Theerthala/Kuvera-PersonalFinance-V2.1
10
+ language:
11
+ - en
12
+ base_model:
13
+ - Qwen/Qwen3-1.7B
14
+ pipeline_tag: text-generation
15
  ---
16
 
17
  # Model Card for Model ID
18
 
19
+ This model is fine-tuned for instruction-following in the domain of personal finance, with a focus on:
20
 
21
+ - Budgeting advice
22
+ - Investment strategies
23
+ - Credit management
24
+ - Retirement planning
25
+ - Insurance and financial planning concepts
26
+ - Personalized financial reasoning
27
 
28
 
 
 
29
  ### Model Description
30
 
31
+ - **License:** MIT
32
+ - **Finetuned from model:** unsloth/Qwen3-1.7B
33
+ - **Dataset:** The model was fine-tuned on the Kuvera-PersonalFinance-V2.1, curated and published by Akhil-Theerthala.
 
 
 
 
 
 
 
 
34
 
35
+ ### Model Capabilities
36
 
37
+ - Understands and provides contextual financial advice based on user queries.
38
+ - Responds in a chat-like conversational format.
39
+ - Trained to follow multi-turn instructions and deliver clear, structured, and accurate financial reasoning.
40
+ - Generalizes well to novel personal finance questions and explanations.
 
41
 
42
  ## Uses
43
 
 
 
44
  ### Direct Use
45
 
46
+ - Chatbots for personal finance
47
+ - Educational assistants for financial literacy
48
+ - Decision support for simple financial planning
49
+ - Interactive personal finance Q&A systems
 
 
 
 
 
50
 
 
 
 
 
 
51
 
52
  ## Bias, Risks, and Limitations
53
 
54
+ - Not a substitute for licensed financial advisors.
55
+ - The model's advice is based on training data and may not reflect region-specific laws, regulations, or financial products.
56
+ - May occasionally hallucinate or give generic responses in ambiguous scenarios.
57
+ - Assumes user input is well-formed and relevant to personal finance.
 
 
 
58
 
 
59
 
60
  ## How to Get Started with the Model
61
 
62
  Use the code below to get started with the model.
63
 
64
+ ```python
65
+ from transformers import AutoTokenizer, AutoModelForCausalLM
66
+
67
+ tokenizer = AutoTokenizer.from_pretrained("khazarai/Personal-Finance-R2")
68
+ model = AutoModelForCausalLM.from_pretrained(
69
+ "khazarai/Personal-Finance-R2",
70
+ device_map={"": 0}
71
+ )
72
+
73
+
74
+ question = """ I just got accepted into Flatiron's full-time software engineering bootcamp, but I have basically no savings and the $19k price tag is freaking me out.
75
+ I really love coding and want to break into tech, but I'm looking at taking out a loan through Climb or Ascent with around 6.5% interest—that'd mean paying like $600 a month after.
76
+ Is this a smart move? I'm torn between chasing this opportunity and being terrified of the debt. Any advice?
77
+ """
78
+
79
+ messages = [
80
+ {"role" : "user", "content" : question}
81
+ ]
82
+ text = tokenizer.apply_chat_template(
83
+ messages,
84
+ tokenize = False,
85
+ add_generation_prompt = True,
86
+ enable_thinking = True,
87
+ )
88
+
89
+ from transformers import TextStreamer
90
+ _ = model.generate(
91
+ **tokenizer(text, return_tensors = "pt").to("cuda"),
92
+ max_new_tokens = 3000,
93
+ temperature = 0.6,
94
+ top_p = 0.95,
95
+ top_k = 20,
96
+ streamer = TextStreamer(tokenizer, skip_prompt = True),
97
+ )
98
+ ```
99
 
100
  ## Training Details
101
 
102
  ### Training Data
103
 
104
+ - Dataset Overview:
105
+ Kuvera-PersonalFinance-V2.1 is a collection of high-quality instruction-response pairs focused on personal finance topics.
106
+ It covers a wide range of subjects including budgeting, saving, investing, credit management, retirement planning, insurance, and financial literacy.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
107
 
108
+ - Data Format:
109
+ The dataset consists of conversational-style prompts paired with detailed and well-structured responses.
110
+ It is formatted to enable instruction-following language models to understand and generate coherent financial advice and reasoning.
111