Update README.md

README.md

@@ -6,4 +6,32 @@ base_model:
 - UBC-NLP/MARBERTv2
 pipeline_tag: text-classification
 ---
-- **Finetuned from model:** [**UBC-NLP/MARBERTv2**](https://huggingface.co/UBC-NLP/MARBERTv2)
+- **Finetuned from model:** [**UBC-NLP/MARBERTv2**](https://huggingface.co/UBC-NLP/MARBERTv2)
+
+## Usage
+```python
+import evaluate
+
+# Load the metric
+fluency = evaluate.load("Baleegh/Fluency_Score")
+fluency.device # 'cuda'
+
+# Some example sentences
+texts = ['هلا أعطيتني هذا', 'هل تستطيع أن تعطيني هذا']
+
+# Compute the scores
+scores = fluency.compute(texts=texts)['classical_score']
+'''array([0.95677805, 0.01825629], dtype=float32)'''
+
+for i in range(len(texts)):
+    print(f"{texts[i]} : Fluency {scores[i]:.2f}")
+
+"""
+هلا أعطيتني هذا : Fluency 0.96
+هل تستطيع أن تعطيني هذا : Fluency 0.02
+
+"""
+```
+
+## تحذير
+قد لا ينفع هذا المقياس مع نصوصك حتى وإن كانت فصيحة، جربه جيدا.