learn-abc commited on
Commit
a1999e4
·
verified ·
1 Parent(s): 6e855d1

update model card with all the configuration details and usage guide

Browse files
Files changed (1) hide show
  1. README.md +134 -124
README.md CHANGED
@@ -3,186 +3,194 @@ 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
 
@@ -190,9 +198,11 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
190
 
191
  [More Information Needed]
192
 
193
- ## Model Card Authors [optional]
194
 
195
- [More Information Needed]
 
 
196
 
197
  ## Model Card Contact
198
 
 
3
  tags: []
4
  ---
5
 
6
+ **Repo:** `learn-abc/banking77-intent-classifier`
7
 
8
+ # Banking77 Intent Classifier (10-Intent)
9
 
10
+ ## Overview
11
 
12
+ This model is a **fine-tuned BERT-based intent classifier** designed for **banking and financial customer queries**.
13
+ It is trained by **mapping the original 77 Banking77 intents into a smaller, production-friendly set of custom intents**, making it suitable for real-world conversational systems where simpler intent routing is required.
14
 
15
+ The model performs **single-label text classification** and is intended to be used as an **intent detection component**, not as a conversational or generative model.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
+ ---
18
 
19
+ ## Model Details
20
 
21
+ * **Base model:** `bert-base-uncased`
22
+ * **Task:** Text Classification (Intent Classification)
23
+ * **Architecture:** `BertForSequenceClassification`
24
+ * **Languages:** English (robust to informal and conversational phrasing)
25
+ * **Max sequence length:** 64 tokens
26
+ * **Output:** One intent label with confidence score
27
 
28
+ ---
29
 
30
+ ## Custom Intent Schema
31
 
32
+ The original **77 Banking77 intents** were **mapped and consolidated** into the following **12 production intents**:
33
 
34
+ * `ACCOUNT_INFO`
35
+ * `ATM_SUPPORT`
36
+ * `CARD_ISSUE`
37
+ * `CARD_MANAGEMENT`
38
+ * `CARD_REPLACEMENT`
39
+ * `CHECK_BALANCE`
40
+ * `EDIT_PERSONAL_DETAILS`
41
+ * `FAILED_TRANSFER`
42
+ * `FEES`
43
+ * `LOST_OR_STOLEN_CARD`
44
+ * `MINI_STATEMENT`
45
+ * `FALLBACK`
46
 
47
+ Any user query that does not clearly belong to one of the supported categories is mapped to **FALLBACK**.
48
 
49
+ This design simplifies downstream business logic while retaining strong intent separation.
50
 
51
+ ---
52
 
53
+ ## Training Data
54
 
55
+ * **Primary dataset:** [PolyAI Banking77](https://huggingface.co/datasets/PolyAI/banking77)
56
+ * **Original training samples:** 10,003
57
+ * **Test samples:** 3,080
58
+ * **After intent mapping and augmentation:**
59
 
60
+ * **Training samples:** 19,846
61
+ * **Includes:** 280 explicitly added `FALLBACK` examples
62
 
63
+ ### Training Intent Distribution (Post-Mapping)
64
 
65
+ | Intent | Samples |
66
+ | --------------------- | ------- |
67
+ | ACCOUNT_INFO | 1,983 |
68
+ | MINI_STATEMENT | 1,809 |
69
+ | FEES | 1,490 |
70
+ | FAILED_TRANSFER | 1,045 |
71
+ | CARD_MANAGEMENT | 1,026 |
72
+ | CARD_REPLACEMENT | 749 |
73
+ | ATM_SUPPORT | 743 |
74
+ | CARD_ISSUE | 456 |
75
+ | CHECK_BALANCE | 352 |
76
+ | LOST_OR_STOLEN_CARD | 229 |
77
+ | EDIT_PERSONAL_DETAILS | 121 |
78
+ | FALLBACK | 280 |
79
 
80
+ Class imbalance was handled using **class weighting** during training.
81
 
82
+ ---
83
 
84
+ ## Training Configuration
85
 
86
+ ```text
87
+ Base Model: bert-base-uncased
88
+ Epochs: 5
89
+ Batch Size: 32
90
+ Learning Rate: 5e-5
91
+ Max Sequence Length: 64
92
+ Optimizer: AdamW
93
+ Loss: Cross-Entropy (with class weights)
94
+ ```
95
 
96
+ ---
97
 
98
+ ## Evaluation Results
99
 
100
+ Final evaluation on the Banking77 test set:
101
 
102
+ * **Accuracy:** 96.04%
103
+ * **F1 (Micro):** 0.960
104
+ * **F1 (Macro):** 0.956
105
 
106
+ These results indicate strong overall performance with good balance across both high-frequency and low-frequency intents.
107
 
108
+ ---
109
 
110
+ ## Usage
111
 
112
+ ### Load the model
113
 
114
+ ```python
115
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification
116
+ import torch
117
 
118
+ model_id = "learn-abc/banking77-intent-classifier"
119
 
120
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
121
+ model = AutoModelForSequenceClassification.from_pretrained(model_id)
122
 
123
+ def predict_intent(text):
124
+ inputs = tokenizer(text, return_tensors="pt", truncation=True, max_length=64)
125
+ with torch.no_grad():
126
+ outputs = model(**inputs)
127
+ probs = torch.softmax(outputs.logits, dim=-1)
128
+ pred_id = probs.argmax(dim=-1).item()
129
+ confidence = probs[0][pred_id].item()
130
 
131
+ return model.config.id2label[pred_id], confidence
132
 
133
+ # Example usage:
134
+ if __name__ == "__main__":
135
+ test_texts = [
136
+ "What is my account balance?",
137
+ "Show me my last 10 transactions.",
138
+ "I want to update my address.",
139
+ "How do I apply for a loan?"
140
+ ]
141
 
142
+ for text in test_texts:
143
+ intent, confidence = predict_intent(text)
144
+ print(f"Input: {text}\nPredicted Intent: {intent} (Confidence: {confidence:.2f})\n")
145
+ ```
146
 
147
+ ---
 
 
148
 
149
+ ## Intended Use
150
 
151
+ This model is suitable for:
152
 
153
+ * Banking chatbots
154
+ * Voice assistant intent routing
155
+ * Customer support automation
156
+ * FAQ classification systems
 
157
 
158
+ It is designed to be used **together with business rules**, confirmation flows, and fallback handling.
159
 
160
+ ---
161
 
162
+ ## Limitations and Safety Notes
163
 
164
+ * The model **does not perform authentication or authorization**
165
+ * It **must not directly trigger financial actions**
166
+ * High-risk intents (e.g. lost or stolen card) should always require explicit user confirmation
167
+ * Predictions should be validated with confidence thresholds and fallback logic
168
 
169
+ This model is **not a replacement for human review** in sensitive workflows.
170
 
171
+ ---
172
 
173
+ ## Notes on Model Warnings
174
 
175
+ During training, warnings related to missing or unexpected keys were observed.
176
+ These are expected when fine-tuning a pre-trained BERT checkpoint for a downstream classification task and **do not impact inference correctness**.
177
 
178
+ ---
179
 
180
+ ## Citation
181
 
182
+ If you use this model, please cite:
183
 
184
+ * Devlin et al., *BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding*
185
+ * PolyAI Banking77 Dataset
186
 
187
+ ---
188
 
189
+ ## Maintainer
190
 
191
+ Developed and fine-tuned for production-oriented banking intent classification.
192
 
193
+ ---
 
 
194
 
195
  [More Information Needed]
196
 
 
198
 
199
  [More Information Needed]
200
 
201
+ ## Model Card Authors
202
 
203
+ * **Author:** [Abhishek Singh](https://github.com/SinghIsWriting/)
204
+ * **LinkedIn:** [My LinkedIn Profile](https://www.linkedin.com/in/abhishek-singh-bba2662a9)
205
+ * **Portfolio:** [Abhishek Singh Portfolio](https://portfolio-abhishek-singh-nine.vercel.app/)
206
 
207
  ## Model Card Contact
208