JayShah07 commited on
Commit
60686b2
·
verified ·
1 Parent(s): acd45f5

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +141 -193
README.md CHANGED
@@ -1,199 +1,147 @@
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
+ language: en
3
+ license: apache-2.0
4
+ tags:
5
+ - text-classification
6
+ - multi-label-classification
7
+ - tinybert
8
+ - pytorch
9
+ datasets:
10
+ - JayShah07/multi_label_reporting
11
+ metrics:
12
+ - accuracy
13
+ - f1
14
+ widget:
15
+ - text: "Show me my current holdings"
16
+ - text: "What are my capital gains for this year?"
17
+ - text: "Give me monthly scheme-wise returns"
18
  ---
19
 
20
+ # TinyBERT Dual Classifier for Investment Reporting
21
+
22
+ This model is a fine-tuned TinyBERT with two classification heads for multi-label classification of investment reporting queries.
23
+
24
+ ## Model Description
25
+
26
+ - **Base Model**: TinyBERT (huawei-noah/TinyBERT_General_4L_312D)
27
+ - **Parameters**: ~14-15M
28
+ - **Architecture**: Single encoder with two independent classification heads
29
+ - **Task**: Multi-label classification (Module + Date)
30
+
31
+ ## Labels
32
+
33
+ **Module Labels (6 classes)**:
34
+ - holdings
35
+ - capital_gains
36
+ - scheme_wise_returns
37
+ - investment_account_wise_returns
38
+ - portfolio_update
39
+ - None_module
40
+
41
+ **Date Labels (7 classes)**:
42
+ - Current Year
43
+ - Previous Year
44
+ - Daily
45
+ - Monthly
46
+ - Weekly
47
+ - Yearly
48
+ - None_date
49
+
50
+ ## Performance
51
+
52
+ **Test Set Results**:
53
+ - Module Accuracy: 1.0000
54
+ - Module F1 Score: 1.0000
55
+ - Date Accuracy: 1.0000
56
+ - Date F1 Score: 1.0000
57
+
58
+ ## Usage
59
+ ```python
60
+ from transformers import AutoTokenizer, AutoModel
61
+ import torch
62
+ import torch.nn as nn
63
+
64
+ # Define model class
65
+ class TinyBERTDualClassifier(nn.Module):
66
+ def __init__(self, num_module_labels, num_date_labels, dropout_rate=0.1):
67
+ super(TinyBERTDualClassifier, self).__init__()
68
+ self.encoder = AutoModel.from_pretrained("JayShah07/tinybert-dual-classifier")
69
+ self.hidden_size = self.encoder.config.hidden_size
70
+ self.dropout = nn.Dropout(p=dropout_rate)
71
+ self.module_classifier = nn.Linear(self.hidden_size, num_module_labels)
72
+ self.date_classifier = nn.Linear(self.hidden_size, num_date_labels)
73
+
74
+ def forward(self, input_ids, attention_mask):
75
+ outputs = self.encoder(input_ids=input_ids, attention_mask=attention_mask)
76
+ cls_output = outputs.last_hidden_state[:, 0, :]
77
+ cls_output = self.dropout(cls_output)
78
+ module_logits = self.module_classifier(cls_output)
79
+ date_logits = self.date_classifier(cls_output)
80
+ return module_logits, date_logits
81
+
82
+ # Load model
83
+ classifier_config = torch.hub.load_state_dict_from_url(
84
+ f"https://huggingface.co/JayShah07/tinybert-dual-classifier/resolve/main/classifier_heads.pt"
85
+ )
86
+
87
+ model = TinyBERTDualClassifier(
88
+ num_module_labels=6,
89
+ num_date_labels=7
90
+ )
91
+
92
+ model.module_classifier.load_state_dict(classifier_config['module_classifier'])
93
+ model.date_classifier.load_state_dict(classifier_config['date_classifier'])
94
+
95
+ tokenizer = AutoTokenizer.from_pretrained("JayShah07/tinybert-dual-classifier")
96
+
97
+ # Inference
98
+ model.eval()
99
+ text = "Show my holdings for this month"
100
+ inputs = tokenizer(text, return_tensors='pt', padding='max_length',
101
+ truncation=True, max_length=128)
102
+
103
+ with torch.no_grad():
104
+ module_logits, date_logits = model(inputs['input_ids'], inputs['attention_mask'])
105
+ module_pred = torch.argmax(module_logits, dim=1).item()
106
+ date_pred = torch.argmax(date_logits, dim=1).item()
107
+
108
+ module_labels = ['holdings', 'capital_gains', 'scheme_wise_returns', 'investment_account_wise_returns', 'portfolio_update', 'None_module']
109
+ date_labels = ['Current Year', 'Previous Year', 'Daily', 'Monthly', 'Weekly', 'Yearly', 'None_date']
110
+
111
+ print(f"Module: {module_labels[module_pred]}")
112
+ print(f"Date: {date_labels[date_pred]}")
113
+ ```
114
 
115
  ## Training Details
116
 
117
+ - **Dataset**: JayShah07/multi_label_reporting
118
+ - **Training Samples**: 3097
119
+ - **Validation Samples**: 387
120
+ - **Test Samples**: 388
121
+ - **Epochs**: 10
122
+ - **Batch Size**: 16
123
+ - **Learning Rate**: 2e-05
124
+ - **Optimizer**: AdamW
125
+ - **Loss Function**: CrossEntropyLoss (separate for each head)
126
+
127
+ ## Latency
128
+
129
+ Average inference latency on sample queries (mean ± std):
130
+ - See notebook for detailed latency analysis
131
+
132
+ ## Citation
133
+
134
+ If you use this model, please cite:
135
+ ```bibtex
136
+ @misc{tinybert-dual-classifier,
137
+ author = {Jay Shah},
138
+ title = {TinyBERT Dual Classifier for Investment Reporting},
139
+ year = {2025},
140
+ publisher = {Hugging Face},
141
+ howpublished = {\url{https://huggingface.co/JayShah07/tinybert-dual-classifier}}
142
+ }
143
+ ```
144
+
145
+ ## License
146
+
147
+ Apache 2.0