learn-abc
/

banking77-intent-classifier-en

@@ -1,188 +1,194 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 [More Information Needed]
@@ -190,10 +196,10 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 [More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+license: mit
+datasets:
+- PolyAI/banking77
+language:
+- en
+metrics:
+- accuracy
+base_model:
+- google-bert/bert-base-uncased
 ---
+**Repo:** `learn-abc/banking77-intent-classifier-en`
+# Banking77 Intent Classifier (12-Intent)
+## Overview
+This model is a **fine-tuned BERT-based intent classifier** designed for **banking and financial customer queries**.
+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.
+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.
+---
+## Model Details
+* **Base model:** `bert-base-uncased`
+* **Task:** Text Classification (Intent Classification)
+* **Architecture:** `BertForSequenceClassification`
+* **Languages:** English (robust to informal and conversational phrasing)
+* **Max sequence length:** 64 tokens
+* **Output:** One intent label with confidence score
+---
+## Custom Intent Schema
+The original **77 Banking77 intents** were **mapped and consolidated** into the following **12 production intents**:
+* `ACCOUNT_INFO`
+* `ATM_SUPPORT`
+* `CARD_ISSUE`
+* `CARD_MANAGEMENT`
+* `CARD_REPLACEMENT`
+* `CHECK_BALANCE`
+* `EDIT_PERSONAL_DETAILS`
+* `FAILED_TRANSFER`
+* `FEES`
+* `LOST_OR_STOLEN_CARD`
+* `MINI_STATEMENT`
+* `TRANSFER`
+* `FALLBACK`
+* `GREETING`
+Any user query that does not clearly belong to one of the supported categories is mapped to **FALLBACK**.
+This design simplifies downstream business logic while retaining strong intent separation.
+---
+## Training Data
+* **Primary dataset:** [PolyAI Banking77](https://huggingface.co/datasets/PolyAI/banking77)
+* **Original training samples:** 10,003
+* **Test samples:** 3,080
+* **After intent mapping and augmentation:**
+  * **Training samples:** 22,256
+  * **Includes:** 570 explicitly added `FALLBACK` examples
+### Training Intent Distribution (Post-Mapping)
+| Intent                | Samples |
+| --------------------- | ------- |
+| MINI_STATEMENT          | 4090 |
+| ACCOUNT_INFO            | 3843 |
+| FEES                    | 2918 |
+| FAILED_TRANSFER         | 2050 |
+| CARD_MANAGEMENT         | 2005 |
+| ATM_SUPPORT             | 1459 |
+| CARD_REPLACEMENT        | 1456 |
+| CHECK_BALANCE           | 1092 |
+| CARD_ISSUE              |  902 |
+| TRANSFER                |  673 |
+| FALLBACK                |  570 |
+| GREETING                |  520 |
+| LOST_OR_STOLEN_CARD     |  445 |
+| EDIT_PERSONAL_DETAILS   |  233 |
+Class imbalance was handled using **class weighting** during training.
+---
+## Evaluation Results
+Final evaluation on the Banking77 test set:
+* **Accuracy:** 95.7%
+* **F1 (Micro):** 0.960
+* **F1 (Macro):** 0.956
+These results indicate strong overall performance with good balance across both high-frequency and low-frequency intents.
+---
+## Usage
+### Load the model
+```python
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+import torch
+model_id = "learn-abc/banking77-intent-classifier-en"
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForSequenceClassification.from_pretrained(model_id)
+def predict_intent(text):
+    inputs = tokenizer(text, return_tensors="pt", truncation=True, max_length=64)
+    with torch.no_grad():
+        outputs = model(**inputs)
+        probs = torch.softmax(outputs.logits, dim=-1)
+        pred_id = probs.argmax(dim=-1).item()
+        confidence = probs[0][pred_id].item()
+    return model.config.id2label[pred_id], confidence
+# Example usage:
+if __name__ == "__main__":
+    test_texts = [
+        "What is my account balance?",
+        "Show me my last 10 transactions.",
+        "I want to update my address.",
+        "How do I apply for a loan?"
+    ]
+    for text in test_texts:
+        intent, confidence = predict_intent(text)
+        print(f"Input: {text}\nPredicted Intent: {intent} (Confidence: {confidence:.2f})\n")
+```
+---
+## Intended Use
+This model is suitable for:
+* Banking chatbots
+* Voice assistant intent routing
+* Customer support automation
+* FAQ classification systems
+It is designed to be used **together with business rules**, confirmation flows, and fallback handling.
+---
+## Limitations and Safety Notes
+* The model **does not perform authentication or authorization**
+* It **must not directly trigger financial actions**
+* High-risk intents (e.g. lost or stolen card) should always require explicit user confirmation
+* Predictions should be validated with confidence thresholds and fallback logic
+This model is **not a replacement for human review** in sensitive workflows.
+---
+## Notes on Model Warnings
+During training, warnings related to missing or unexpected keys were observed.
+These are expected when fine-tuning a pre-trained BERT checkpoint for a downstream classification task and **do not impact inference correctness**.
+---
+## Citation
+If you use this model, please cite:
+* Devlin et al., *BERT: Pre-training of Deep Bidirectional Transformers for Language Understanding*
+* PolyAI Banking77 Dataset
+---
+## Maintainer
+Developed and fine-tuned for production-oriented banking intent classification.
+---
 [More Information Needed]
 [More Information Needed]
+## Model Card Authors
+* **Author:** [Abhishek Singh](https://github.com/SinghIsWriting/)
+* **LinkedIn:** [My LinkedIn Profile](https://www.linkedin.com/in/abhishek-singh-bba2662a9)
+* **Portfolio:** [Abhishek Singh Portfolio](https://portfolio-abhishek-singh-nine.vercel.app/)
+---