Rustamshry commited on
Commit
54dba8d
·
verified ·
1 Parent(s): a2606c4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +81 -153
README.md CHANGED
@@ -1,202 +1,130 @@
1
  ---
2
  base_model: unsloth/Qwen3-1.7B
3
  library_name: peft
 
 
 
 
 
 
 
 
 
 
 
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
 
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]
200
  ### Framework versions
201
 
202
  - PEFT 0.15.2
 
1
  ---
2
  base_model: unsloth/Qwen3-1.7B
3
  library_name: peft
4
+ license: mit
5
+ datasets:
6
+ - Akhil-Theerthala/Kuvera-PersonalFinance-V2.1
7
+ language:
8
+ - en
9
+ pipeline_tag: text-generation
10
+ tags:
11
+ - trl
12
+ - unsloth
13
+ - sft
14
+ - transformers
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
 
30
  ### Model Description
31
 
32
+ - **License:** MIT
33
+ - **Finetuned from model:** unsloth/Qwen3-1.7B
34
+ - **Dataset:** The model was fine-tuned on the PersonalFinance_v2 dataset, curated and published by Akhil-Theerthala.
35
 
36
+ ### Model Capabilities
37
 
38
+ - Understands and provides contextual financial advice based on user queries.
39
+ - Responds in a chat-like conversational format.
40
+ - Trained to follow multi-turn instructions and deliver clear, structured, and accurate financial reasoning.
41
+ - Generalizes well to novel personal finance questions and explanations.
 
 
 
 
 
 
 
 
 
 
 
 
42
 
43
  ## Uses
44
 
 
 
45
  ### Direct Use
46
 
47
+ - Chatbots for personal finance
48
+ - Educational assistants for financial literacy
49
+ - Decision support for simple financial planning
50
+ - Interactive personal finance Q&A systems
 
 
 
51
 
 
 
 
 
 
 
 
52
 
53
  ## Bias, Risks, and Limitations
54
 
55
+ - Not a substitute for licensed financial advisors.
56
+ - The model's advice is based on training data and may not reflect region-specific laws, regulations, or financial products.
57
+ - May occasionally hallucinate or give generic responses in ambiguous scenarios.
58
+ - Assumes user input is well-formed and relevant to personal finance.
59
 
 
 
 
 
 
60
 
61
  ## How to Get Started with the Model
62
 
63
  Use the code below to get started with the model.
64
 
65
+ ```python
66
+ from huggingface_hub import login
67
+ from transformers import AutoTokenizer, AutoModelForCausalLM
68
+ from peft import PeftModel
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
+ login(token="")
71
 
72
+ tokenizer = AutoTokenizer.from_pretrained("unsloth/Qwen3-1.7B",)
73
+ base_model = AutoModelForCausalLM.from_pretrained(
74
+ "unsloth/Qwen3-1.7B",
75
+ device_map={"": 0}, token=""
76
+ )
77
 
78
+ model = PeftModel.from_pretrained(base_model,"khazarai/Personal-Finance-R2")
79
 
 
80
 
81
+ question =
82
+ """
83
+ $19k for a coding bootcamp
84
 
85
+ Hi!
86
 
87
+ I was just accepted into the full-time software engineering program with Flatiron and have approx. $0 to my name.
88
+ I know I can get a loan with either Climb or accent with around 6.50% interest, is this a good option?
89
+ I would theoretically be paying near $600/month.
90
 
91
+ I really enjoy coding and would love to start a career in tech but the potential $19k price tag is pretty scary. Any advice?
92
+ """
93
 
94
+ messages = [
95
+ {"role" : "user", "content" : question}
96
+ ]
97
+ text = tokenizer.apply_chat_template(
98
+ messages,
99
+ tokenize = False,
100
+ add_generation_prompt = True,
101
+ enable_thinking = True,
102
+ )
103
 
104
+ from transformers import TextStreamer
105
+ _ = model.generate(
106
+ **tokenizer(text, return_tensors = "pt").to("cuda"),
107
+ max_new_tokens = 3000,
108
+ temperature = 0.6,
109
+ top_p = 0.95,
110
+ top_k = 20,
111
+ streamer = TextStreamer(tokenizer, skip_prompt = True),
112
+ )
113
+ ```
114
 
115
+ ## Training Details
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
116
 
117
+ ### Training Data
118
 
119
+ - Dataset Overview:
120
+ PersonalFinance_v2 is a collection of high-quality instruction-response pairs focused on personal finance topics.
121
+ It covers a wide range of subjects including budgeting, saving, investing, credit management, retirement planning, insurance, and financial literacy.
122
 
123
+ - Data Format:
124
+ The dataset consists of conversational-style prompts paired with detailed and well-structured responses.
125
+ It is formatted to enable instruction-following language models to understand and generate coherent financial advice and reasoning.
126
 
 
127
 
 
128
  ### Framework versions
129
 
130
  - PEFT 0.15.2