Update README.md

README.md

@@ -4,5 +4,49 @@ language:
 - tr
 metrics:
 - f1
+- accuracy
+- recall
+- confusion_matrix
+- precision
 pipeline_tag: text-classification
----
+
+# About the Model
+
+This model is a Turkish-based convBERT model created to classify Turkish social media bullying data. Classes included in the model
+
+* Cinsiyetçilik
+* Irkçılık
+* Kızdırma
+* Nötr
+
+
+The model was trained from a dataset containing 2981 Twitter data.
+
+
+
+
+## Dependency 
+
+pip install transformers
+
+pip install torch
+
+
+## Example 
+
+
+```python
+from transformers import DistilBertTokenizer, DistilBertForSequenceClassification,TextClassificationPipeline
+
+tokenizer = ConvBertTokenizer.from_pretrained("AIZinu/distilBERT-turkish-based-cyberbullying-model")
+model = ConvBertForSequenceClassification.from_pretrained("AIZinu/distilBERT-turkish-based-cyberbullying-model")
+
+pipe= TextClassificationPipeline(model=model, tokenizer=tokenizer)
+
+print(pipe("Hadi modeli deneyelim"))
+```
+
+
+## Model Card Authors
+
+* Bilge Nur BEKAR