Update README.md
Browse files
README.md
CHANGED
|
@@ -1,199 +1,125 @@
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
---
|
| 5 |
|
| 6 |
-
# Model Card for
|
| 7 |
-
|
| 8 |
-
<!-- Provide a quick summary of what the model is/does. -->
|
| 9 |
|
|
|
|
| 10 |
|
|
|
|
| 11 |
|
| 12 |
## Model Details
|
| 13 |
|
| 14 |
### Model Description
|
| 15 |
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
- **Developed by:** [More Information Needed]
|
| 21 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 22 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 23 |
-
- **Model type:** [More Information Needed]
|
| 24 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 25 |
-
- **License:** [More Information Needed]
|
| 26 |
-
- **Finetuned from model [optional]:** [More Information Needed]
|
| 27 |
-
|
| 28 |
-
### Model Sources [optional]
|
| 29 |
-
|
| 30 |
-
<!-- Provide the basic links for the model. -->
|
| 31 |
-
|
| 32 |
-
- **Repository:** [More Information Needed]
|
| 33 |
-
- **Paper [optional]:** [More Information Needed]
|
| 34 |
-
- **Demo [optional]:** [More Information Needed]
|
| 35 |
-
|
| 36 |
-
## Uses
|
| 37 |
-
|
| 38 |
-
<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
|
| 39 |
-
|
| 40 |
-
### Direct Use
|
| 41 |
-
|
| 42 |
-
<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
|
| 43 |
-
|
| 44 |
-
[More Information Needed]
|
| 45 |
-
|
| 46 |
-
### Downstream Use [optional]
|
| 47 |
-
|
| 48 |
-
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
|
| 49 |
-
|
| 50 |
-
[More Information Needed]
|
| 51 |
-
|
| 52 |
-
### Out-of-Scope Use
|
| 53 |
-
|
| 54 |
-
<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
|
| 55 |
-
|
| 56 |
-
[More Information Needed]
|
| 57 |
-
|
| 58 |
-
## Bias, Risks, and Limitations
|
| 59 |
-
|
| 60 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 61 |
-
|
| 62 |
-
[More Information Needed]
|
| 63 |
-
|
| 64 |
-
### Recommendations
|
| 65 |
|
| 66 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 67 |
|
| 68 |
-
|
| 69 |
|
| 70 |
-
|
| 71 |
-
|
| 72 |
-
Use the code below to get started with the model.
|
| 73 |
-
|
| 74 |
-
[More Information Needed]
|
| 75 |
|
| 76 |
## Training Details
|
| 77 |
|
| 78 |
### Training Data
|
| 79 |
|
| 80 |
-
|
| 81 |
-
|
| 82 |
-
[More Information Needed]
|
| 83 |
|
| 84 |
### Training Procedure
|
| 85 |
|
| 86 |
-
|
| 87 |
-
|
| 88 |
-
|
| 89 |
-
|
| 90 |
-
|
| 91 |
-
|
| 92 |
-
|
| 93 |
-
#### Training Hyperparameters
|
| 94 |
-
|
| 95 |
-
- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
|
| 96 |
|
| 97 |
-
|
| 98 |
-
|
| 99 |
-
<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
|
| 100 |
-
|
| 101 |
-
[More Information Needed]
|
| 102 |
|
| 103 |
## Evaluation
|
| 104 |
|
| 105 |
-
|
| 106 |
-
|
| 107 |
-
### Testing Data, Factors & Metrics
|
| 108 |
-
|
| 109 |
-
#### Testing Data
|
| 110 |
-
|
| 111 |
-
<!-- This should link to a Dataset Card if possible. -->
|
| 112 |
-
|
| 113 |
-
[More Information Needed]
|
| 114 |
-
|
| 115 |
-
#### Factors
|
| 116 |
-
|
| 117 |
-
<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
|
| 118 |
-
|
| 119 |
-
[More Information Needed]
|
| 120 |
-
|
| 121 |
-
#### Metrics
|
| 122 |
-
|
| 123 |
-
<!-- These are the evaluation metrics being used, ideally with a description of why. -->
|
| 124 |
-
|
| 125 |
-
[More Information Needed]
|
| 126 |
-
|
| 127 |
-
### Results
|
| 128 |
-
|
| 129 |
-
[More Information Needed]
|
| 130 |
-
|
| 131 |
-
#### Summary
|
| 132 |
-
|
| 133 |
-
|
| 134 |
|
| 135 |
-
|
|
|
|
|
|
|
|
|
|
| 136 |
|
| 137 |
-
<!-- Relevant interpretability work for the model goes here -->
|
| 138 |
|
| 139 |
-
|
| 140 |
-
|
| 141 |
-
## Environmental Impact
|
| 142 |
-
|
| 143 |
-
<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
|
| 144 |
-
|
| 145 |
-
Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
|
| 146 |
-
|
| 147 |
-
- **Hardware Type:** [More Information Needed]
|
| 148 |
-
- **Hours used:** [More Information Needed]
|
| 149 |
-
- **Cloud Provider:** [More Information Needed]
|
| 150 |
-
- **Compute Region:** [More Information Needed]
|
| 151 |
-
- **Carbon Emitted:** [More Information Needed]
|
| 152 |
-
|
| 153 |
-
## Technical Specifications [optional]
|
| 154 |
-
|
| 155 |
-
### Model Architecture and Objective
|
| 156 |
-
|
| 157 |
-
[More Information Needed]
|
| 158 |
-
|
| 159 |
-
### Compute Infrastructure
|
| 160 |
-
|
| 161 |
-
[More Information Needed]
|
| 162 |
-
|
| 163 |
-
#### Hardware
|
| 164 |
-
|
| 165 |
-
[More Information Needed]
|
| 166 |
|
| 167 |
-
###
|
| 168 |
|
| 169 |
-
|
|
|
|
|
|
|
| 170 |
|
| 171 |
-
##
|
| 172 |
|
| 173 |
-
|
|
|
|
|
|
|
| 174 |
|
| 175 |
-
|
| 176 |
|
| 177 |
-
|
|
|
|
|
|
|
|
|
|
| 178 |
|
| 179 |
-
|
| 180 |
|
| 181 |
-
|
| 182 |
|
| 183 |
-
##
|
| 184 |
|
| 185 |
-
|
|
|
|
| 186 |
|
| 187 |
-
|
|
|
|
|
|
|
| 188 |
|
| 189 |
-
|
| 190 |
|
| 191 |
-
|
|
|
|
|
|
|
| 192 |
|
| 193 |
-
## Model Card Authors [optional]
|
| 194 |
|
| 195 |
-
[More Information Needed]
|
| 196 |
|
| 197 |
-
## Model Card Contact
|
| 198 |
|
| 199 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
library_name: transformers
|
| 3 |
+
pipeline_tag: text-classification
|
| 4 |
+
tags:
|
| 5 |
+
- hate-speech
|
| 6 |
+
- arabic
|
| 7 |
+
- classification
|
| 8 |
+
- bert
|
| 9 |
+
- social-media
|
| 10 |
+
- moderation
|
| 11 |
+
language:
|
| 12 |
+
- ar
|
| 13 |
+
license: mit
|
| 14 |
+
datasets:
|
| 15 |
+
- IbrahimAmin/egyptian-arabic-hate-speech
|
| 16 |
+
metrics:
|
| 17 |
+
- accuracy
|
| 18 |
+
- f1
|
| 19 |
+
widget:
|
| 20 |
+
- text: هذا نص عربي للاختبار
|
| 21 |
+
base_model:
|
| 22 |
+
- CAMeL-Lab/bert-base-arabic-camelbert-da-sentiment
|
| 23 |
---
|
| 24 |
|
| 25 |
+
# Model Card for hossam87/bert-base-arabic-hate-speech
|
|
|
|
|
|
|
| 26 |
|
| 27 |
+
A fine-tuned BERT model to classify Arabic text into: Neutral, Offensive, Sexism, Religious Discrimination, or Racism.
|
| 28 |
|
| 29 |
+
---
|
| 30 |
|
| 31 |
## Model Details
|
| 32 |
|
| 33 |
### Model Description
|
| 34 |
|
| 35 |
+
This model is based on `bert-base-multilingual-cased` and fine-tuned on an Arabic social media dataset for hate speech detection.
|
| 36 |
+
It classifies Arabic text into one of five categories: Neutral, Offensive, Sexism, Religious Discrimination, or Racism.
|
| 37 |
+
Intended uses include moderation, analytics, and academic research.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 38 |
|
| 39 |
+
- **Developed by:** [hossam87](https://huggingface.co/hossam87)
|
| 40 |
+
- **Model type:** Sequence classification (BERT)
|
| 41 |
+
- **Language(s):** Arabic (ar)
|
| 42 |
+
- **License:** MIT
|
| 43 |
+
- **Finetuned from model:** [bert-base-multilingual-cased](https://huggingface.co/bert-base-multilingual-cased)
|
| 44 |
|
| 45 |
+
### Model Sources
|
| 46 |
|
| 47 |
+
- **Repository:** [https://huggingface.co/hossam87/bert-base-arabic-hate-speech](https://huggingface.co/hossam87/bert-base-arabic-hate-speech)
|
| 48 |
+
- **Demo:** [https://huggingface.co/spaces/hossam87/arabic-hate-speech-detector](https://huggingface.co/spaces/hossam87/arabic-hate-speech-detector)
|
|
|
|
|
|
|
|
|
|
| 49 |
|
| 50 |
## Training Details
|
| 51 |
|
| 52 |
### Training Data
|
| 53 |
|
| 54 |
+
The model was fine-tuned on a labeled dataset of Arabic social media posts, manually annotated for the five target categories.
|
|
|
|
|
|
|
| 55 |
|
| 56 |
### Training Procedure
|
| 57 |
|
| 58 |
+
- **Precision:** Mixed precision (`fp16`)
|
| 59 |
+
- **Epochs:** 4 (best model at epoch 3)
|
| 60 |
+
- **Batch size:** 32
|
| 61 |
+
- **Learning rate:** 3e-5
|
| 62 |
+
- **Optimizer:** AdamW
|
| 63 |
+
- **Hardware:** 2 x NVIDIA T4 GPUs (Kaggle)
|
|
|
|
|
|
|
|
|
|
|
|
|
| 64 |
|
| 65 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
| 66 |
|
| 67 |
## Evaluation
|
| 68 |
|
| 69 |
+
### Metrics
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 70 |
|
| 71 |
+
| Metric | Score |
|
| 72 |
+
|----------|:------:|
|
| 73 |
+
| Accuracy | 0.944 |
|
| 74 |
+
| F1 Macro | 0.946 |
|
| 75 |
|
|
|
|
| 76 |
|
| 77 |
+
## Uses
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 78 |
|
| 79 |
+
### Direct Use
|
| 80 |
|
| 81 |
+
- Content moderation for Arabic social media, forums, and chats.
|
| 82 |
+
- Analytics and research into hate speech patterns in Arabic.
|
| 83 |
+
- Educational and academic projects.
|
| 84 |
|
| 85 |
+
### Out-of-Scope Use
|
| 86 |
|
| 87 |
+
- Automated moderation without human oversight in sensitive or legal contexts.
|
| 88 |
+
- Use on languages other than Arabic.
|
| 89 |
+
- General text classification tasks outside hate speech detection.
|
| 90 |
|
| 91 |
+
## Bias, Risks, and Limitations
|
| 92 |
|
| 93 |
+
The model may misclassify:
|
| 94 |
+
- Sarcasm, slang, or context-dependent expressions.
|
| 95 |
+
- Formal written Arabic, since trained on social media content.
|
| 96 |
+
- Domain-specific or emerging hate speech not represented in the training data.
|
| 97 |
|
| 98 |
+
### Recommendations
|
| 99 |
|
| 100 |
+
Always keep a human-in-the-loop for sensitive moderation tasks. Use responsibly and be transparent about automation.
|
| 101 |
|
| 102 |
+
## How to Get Started with the Model
|
| 103 |
|
| 104 |
+
```python
|
| 105 |
+
from transformers import AutoTokenizer, AutoModelForSequenceClassification, pipeline
|
| 106 |
|
| 107 |
+
model_id = "hossam87/bert-base-arabic-hate-speech"
|
| 108 |
+
tokenizer = AutoTokenizer.from_pretrained(model_id)
|
| 109 |
+
model = AutoModelForSequenceClassification.from_pretrained(model_id)
|
| 110 |
|
| 111 |
+
classifier = pipeline("text-classification", model=model, tokenizer=tokenizer)
|
| 112 |
|
| 113 |
+
text = "هذا نص عربي للاختبار"
|
| 114 |
+
result = classifier(text)
|
| 115 |
+
print(result)
|
| 116 |
|
|
|
|
| 117 |
|
|
|
|
| 118 |
|
|
|
|
| 119 |
|
| 120 |
+
@misc{hossam87_2025_arabichate,
|
| 121 |
+
title = {BERT-base Arabic Hate Speech Detector},
|
| 122 |
+
author = {Hossam87},
|
| 123 |
+
year = {2025},
|
| 124 |
+
howpublished = {\url{https://huggingface.co/hossam87/bert-base-arabic-hate-speech}},
|
| 125 |
+
}
|