Update README.md

README.md

@@ -22,34 +22,56 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-Base model:  'bert-base-cased'
+Base model:  'bert-base-cased' it can be used for intent classification. It trained on the [Intent-Classification-Commands](https://huggingface.co/datasets/dipesh/Intent-Classification-Commands) dataset. With following classes-
+
+```
+{
+  "0": "asking date",
+  "1": "asking time",
+  "2": "asking weather",
+  "3": "check internet speed",
+  "4": "click photo",
+  "5": "covid cases",
+  "6": "download youtube video",
+  "7": "goodbye",
+  "8": "greet",
+  "9": "open website",
+  "10": "play games",
+  "11": "play on youtube",
+  "12": "send email",
+  "13": "send whatsapp message",
+  "14": "take screenshot",
+  "15": "tell me about",
+  "16": "tell me joke",
+  "17": "tell me news"
+}
+```
 
 ## Intended uses & limitations
 
-Intent Classifications for Chatbot or Virtual Assistant
+Intent Classifications for Chatbot or Virtual Assistant.
+Only supports English language. It can't work on outside classes. But you can fine-tune it for your own use.
 
 ## Training and evaluation data
 
-More information needed
+Dataset Used: [Intent-Classification-Commands](https://huggingface.co/datasets/dipesh/Intent-Classification-Commands)
 
 ## Training procedure
 
-https://colab.research.google.com/drive/1tyXIbY875w0U8OuqEwfanecck5i-OfU6?usp=sharing
+https://colab.research.google.com/drive/1KHg14glvhdV_ziOcY0pHm66PBYoBZMS0?usp=sharing
 
 ### Training hyperparameters
 
+
 The following hyperparameters were used during training:
 - optimizer: {'name': 'Adam', 'learning_rate': 5e-05, 'decay': 0.0, 'beta_1': 0.9, 'beta_2': 0.999, 'epsilon': 1e-07, 'amsgrad': False}
 - training_precision: float32
 
 ### Training results
 
-| Train Loss | Train Sparse Categorical Accuracy | Validation Loss | Validation Sparse Categorical Accuracy | Epoch |
-|:----------:|:---------------------------------:|:---------------:|:--------------------------------------:|:-----:|
-| 2.5420     | 0.3224                            | 1.9997          | 0.6806                                 | 0     |
-| 1.4238     | 0.8684                            | 0.9106          | 0.9444                                 | 1     |
-| 0.6110     | 0.9836                            | 0.4073          | 0.9583                                 | 2     |
+![img.png](img.png)
 
+![img_1.png](img_1.png)
 
 ### Framework versions