Update README.md

README.md

@@ -5,14 +5,15 @@ language:
 ---
 # Toxicity-classifier
 
+## Model Overview
+
 The toxicity classifier is used to differentiate between non-toxic and toxic comments.
 
 The model was trained with a dataset composed of toxic and non-toxic comments extracted from web forums.
 
 ## Details
 - **Size:** 4,689,681 parameters
-- **Dataset:** [Toxic Comment Classification Challenge Dataset](https://huggingface.co/datasets/AiresPucrs/toxic-comments)
-- **Language:** English
+- **Model type:** Transformer
 - **Number of Epochs:** 20
 - **Batch Size:** 16
 - **Optimizer:** Adam
@@ -20,7 +21,8 @@ The model was trained with a dataset composed of toxic and non-toxic comments ex
 - **Hardware:** Tesla V4 
 - **Emissions:** Not measured
 - **Total Energy Consumption:** Not measured
-## Usage
+
+## How to Use
 
 ⚠️ THE EXAMPLES BELOW CONTAIN TOXIC/OFFENSIVE LANGUAGE ⚠️
 
@@ -64,18 +66,24 @@ Toxic 🤬 0.99% | Not toxic 😊 99.01
 __________________________________________________
 ```
 
-# Cite as 🤗
+## Training Data
 
-```
+- **Dataset:** [Toxic Comment Classification Challenge Dataset](https://huggingface.co/datasets/AiresPucrs/toxic-comments)
+
+## Cite as
+
+```latex
 @misc{teenytinycastle,
     doi = {10.5281/zenodo.7112065},
-    url = {https://huggingface.co/AiresPucrs/toxicity_model},
+    url = {https://github.com/Nkluge-correa/teeny-tiny_castle},
     author = {Nicholas Kluge Corr{\^e}a},
     title = {Teeny-Tiny Castle},
-    year = {2023},
-    publisher = {HuggingFace},
-    journal = {HuggingFace repository},
+    year = {2024},
+    publisher = {GitHub},
+    journal = {GitHub repository},
 }
 ```
+
 ## License
-The ToxicityModel is licensed under the Apache License, Version 2.0. See the LICENSE file for more details.
+
+This model is licensed under the Apache License, Version 2.0. See the [LICENSE](LICENSE) file for more details.