Create README.md

README.md

@@ -0,0 +1,27 @@
+---
+language:
+- ku
+metrics:
+- perplexity
+pipeline_tag: fill-mask
+---
+
+# KurdBERT
+   - Type: BERT-based language model transformer
+   - Description: KurdBERT is a pre-trained language model specifically tailored for the Kurdish languages (Sorani and Kurmanji). It can be used for various NLP tasks, including text classification, named entity recognition, and more.
+
+## How to use
+```python
+# Use a pipeline as a high-level helper
+from transformers import pipeline
+
+pipe = pipeline("fill-mask", model="language-ml-lab/KurdBert")
+```
+
+```python
+# Load model directly
+from transformers import AutoTokenizer, AutoModelForMaskedLM
+
+tokenizer = AutoTokenizer.from_pretrained("language-ml-lab/KurdBert")
+model = AutoModelForMaskedLM.from_pretrained("language-ml-lab/KurdBert")
+```