update our README.md file
Browse files
README.md
CHANGED
|
@@ -1,19 +1,53 @@
|
|
| 1 |
---
|
| 2 |
-
## This project uses a fine-tuned BERT model that is an encoder only model without a decoder used to detect user intent from text inputs (e.g., chatbot queries).
|
| 3 |
-
|
| 4 |
-
|
| 5 |
-
|
| 6 |
license: apache-2.0
|
|
|
|
| 7 |
datasets:
|
| 8 |
- clinc/clinc_oos
|
| 9 |
metrics:
|
| 10 |
- accuracy
|
| 11 |
-
base_model:
|
| 12 |
-
- google-bert/bert-base-uncased
|
| 13 |
library_name: transformers
|
| 14 |
tags:
|
|
|
|
|
|
|
| 15 |
- finance
|
| 16 |
- travel
|
| 17 |
- banking
|
| 18 |
-
|
| 19 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
license: apache-2.0
|
| 3 |
+
base_model: google-bert/bert-base-uncased
|
| 4 |
datasets:
|
| 5 |
- clinc/clinc_oos
|
| 6 |
metrics:
|
| 7 |
- accuracy
|
|
|
|
|
|
|
| 8 |
library_name: transformers
|
| 9 |
tags:
|
| 10 |
+
- nlp
|
| 11 |
+
- intent-classification
|
| 12 |
- finance
|
| 13 |
- travel
|
| 14 |
- banking
|
| 15 |
+
|
| 16 |
+
---
|
| 17 |
+
|
| 18 |
+
## 🤖 Intent Detection using Fine-Tuned BERT
|
| 19 |
+
|
| 20 |
+
This project utilizes a fine-tuned BERT model (`bert-base-uncased`) for **intent classification** tasks. It is an **encoder-only transformer** designed to detect user intents from text inputs (e.g., chatbot queries) and classify them into predefined categories such as `banking`, `travel`, `finance`, and more.
|
| 21 |
+
|
| 22 |
+
The model is trained on the [CLINC150 (clinc_oos)](https://huggingface.co/datasets/clinc/clinc_oos) dataset and evaluated using accuracy as the primary metric.
|
| 23 |
+
|
| 24 |
+
---
|
| 25 |
+
## 📊 Dataset --> CLINC150
|
| 26 |
+
|
| 27 |
+
The project uses the **CLINC150 dataset**, a benchmark dataset for intent classification in task-oriented dialogue systems.
|
| 28 |
+
|
| 29 |
+
---
|
| 30 |
+
### 🧾 Dataset Overview
|
| 31 |
+
|
| 32 |
+
- **Total intents**: 150 unique user intents
|
| 33 |
+
- **Domains**: 10 real-world domains (e.g., banking, travel, weather, small talk)
|
| 34 |
+
- **Examples**: ~22,500 utterances
|
| 35 |
+
- **Language**: English
|
| 36 |
+
- **Out-of-scope (OOS)**: Includes OOS examples to test robustness
|
| 37 |
+
|
| 38 |
+
---
|
| 39 |
+
|
| 40 |
+
### 📦 Source
|
| 41 |
+
|
| 42 |
+
- Official repo: [clinc/oos-eval](https://github.com/clinc/oos-eval)
|
| 43 |
+
- Hugging Face: [`clinc_oos`](https://huggingface.co/datasets/clinc_oos)
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
+
|
| 47 |
+
## 🚀 Example
|
| 48 |
+
|
| 49 |
+
### Request: "I want to book a flight"
|
| 50 |
+
|
| 51 |
+
### Response: "book_flight"
|
| 52 |
+
```
|
| 53 |
+
|