Update README.md

README.md

@@ -9,6 +9,38 @@ tags:
 - classification
 library_name: PyTorch
 ---
+
 # Dzarashield
 
-dzarashield is a finetuned model of ([DzaraBert](https://huggingface.co/Sifal/dzarabert))
+Dzarashield is a fine-tuned model based on [DzaraBert](https://huggingface.co/Sifal/dzarabert) designed for text classification tasks. It specializes in hate speech detection for Arabic text.
+
+
+## Limitations 
+
+It's important to note that this model has been fine-tuned solely on Arabic characters, which means that tokens from other languages have been pruned.
+
+# How to use
+
+```
+!git lfs install
+!git clone https://huggingface.co/Sifal/dzarashield
+%cd dzarashield
+
+from model import BertClassifier
+from transformers import PreTrainedTokenizerFast
+
+dzarashield = BertClassifier()
+PATH = "./pytorch_model.bin"
+
+dzarashield.load_state_dict(torch.load(PATH))
+tokenizer = PreTrainedTokenizerFast(tokenizer_file="tokenizer.json")
+
+```
+
+## Acknowledgments
+
+Dzarashield is built upon the foundations of [Dziribert](https://huggingface.co/alger-ia/dziribert), and I am grateful for their work in making this project possible.
+
+## References
+
+- [Dziribert](https://arxiv.org/pdf/2109.12346.pdf)