Update README.md

README.md

@@ -1,47 +1,53 @@
 ---
-tags:
-- generated_from_keras_callback
 model-index:
 - name: twitter-roberta-base-hate-multiclass-latest
   results: []
+language:
+- en
+pipeline_tag: text-classification
 ---
 
-<!-- This model card has been generated automatically according to the information Keras had access to. You should
-probably proofread and complete it, then remove this comment. -->
 
-# twitter-roberta-base-hate-multiclass-latest
+# cardiffnlp/twitter-roberta-base-hate-multiclass-latest
 
-This model was trained from scratch on an unknown dataset.
-It achieves the following results on the evaluation set:
+This model is a fine-tuned version of [cardiffnlp/twitter-roberta-base-2022-154m](https://huggingface.co/cardiffnlp/twitter-roberta-base-2022-154m) for multiclass hate-speech classification. A combination of 13 different hate-speech datasets in the English language were used to fine-tune the model.
 
+## Classes available
+```
+{
+  "sexism": 0,
+  "racism": 1,
+  "disability": 2,
+  "sexual_orientation": 3,
+  "religion": 4,
+  "other": 5,
+  "not_hate":6
+}
+```
 
-## Model description
+## Following metrics are achieved 
+* Accuracy: 0.9419
+* Macro-F1: 0.5752
+* Weighted-F1: 0.9390
 
-More information needed
+### Usage
+Install tweetnlp via pip.
+```shell
+pip install tweetnlp
+```
+Load the model in python.
+```python
+import tweetnlp
+model = tweetnlp.Classifier("cardiffnlp/twitter-roberta-base-hate-latest")
+model.predict('Women are trash 2.')
+>> {'label': 'sexism'}
+model.predict('@user dear mongoloid respect sentiments & belief refrain totalitarianism. @user')
+>> {'label': 'disability'}
 
-## Intended uses & limitations
+```
 
-More information needed
 
-## Training and evaluation data
+```
 
-More information needed
 
-## Training procedure
-
-### Training hyperparameters
-
-The following hyperparameters were used during training:
-- optimizer: None
-- training_precision: float32
-
-### Training results
-
-
-
-### Framework versions
-
-- Transformers 4.30.2
-- TensorFlow 2.12.0
-- Datasets 2.10.1
-- Tokenizers 0.12.1
+```