HussainKAUST commited on
Commit
c1121fb
·
verified ·
1 Parent(s): 37b0fb5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +47 -15
README.md CHANGED
@@ -2,34 +2,66 @@
2
  language: ar
3
  base_model: faisalq/SaudiBERT
4
  tags:
5
- - eou
6
- - turn-taking
7
  - arabic
8
  - saudi
 
 
 
 
9
  ---
10
 
11
  # Saudi Arabic End-of-Utterance (EOU) Model
12
 
13
- This is a fine-tuned **SaudiBERT** model for **End-of-Utterance (EOU) detection** in Saudi Arabic conversational text.
 
 
 
14
 
15
  ## Task
16
- Binary classification:
17
- - 0 → Incomplete utterance
18
- - 1End of utterance
 
 
 
 
 
 
 
 
 
 
 
19
 
20
  ## Training
21
- - Base model: faisalq/SaudiBERT
22
- - Data: Saudi Arabic conversational dataset
23
- - Loss: Focal Loss
24
- - Metric: F1-score
 
 
 
 
 
 
 
 
 
 
 
 
25
 
26
- ## Usage
27
  ```python
28
  from transformers import AutoTokenizer, AutoModelForSequenceClassification
29
  import torch
30
 
31
- tok = AutoTokenizer.from_pretrained("HussainKAUST/saudi-eou-model")
32
- mdl = AutoModelForSequenceClassification.from_pretrained("HussainKAUST/saudi-eou-model")
 
 
 
 
 
 
33
 
34
- x = tok("ابي احجز موعد بس ...", return_tensors="pt")
35
- p = torch.sigmoid(mdl(**x).logits).item()
 
2
  language: ar
3
  base_model: faisalq/SaudiBERT
4
  tags:
 
 
5
  - arabic
6
  - saudi
7
+ - eou
8
+ - turn-taking
9
+ - conversational-ai
10
+ license: mit
11
  ---
12
 
13
  # Saudi Arabic End-of-Utterance (EOU) Model
14
 
15
+ This model detects **End-of-Utterance (EOU)** events in **Saudi Arabic conversational text**.
16
+ It outputs the probability that a speaker has **finished their turn**, enabling natural turn-taking in real-time voice agents (e.g., LiveKit).
17
+
18
+ ---
19
 
20
  ## Task
21
+ Binary classification (probability output):
22
+
23
+ - **0**Incomplete utterance (speaker likely to continue)
24
+ - **1** → Complete utterance (end of turn)
25
+
26
+ ---
27
+
28
+ ## Model Details
29
+ - **Base model:** `faisalq/SaudiBERT`
30
+ - **Architecture:** BERT Sequence Classification
31
+ - **Output:** Single probability (sigmoid)
32
+ - **Dialect focus:** Saudi Arabic (ar-SA)
33
+
34
+ ---
35
 
36
  ## Training
37
+ - **Dataset:** Saudi Arabic conversational EOU dataset
38
+ https://huggingface.co/datasets/HussainKAUST/saudi-eou-dataset
39
+ - **Data source:** Synthetic Saudi dialogue with natural pauses and incomplete turns
40
+ - **Loss:** Focal Loss (class imbalance handling)
41
+ - **Epochs:** 6
42
+
43
+ ---
44
+
45
+ ## Evaluation Results
46
+ - **Validation F1:** ~0.83
47
+ - **Test F1:** ~0.75
48
+ - **Test Accuracy:** ~0.81
49
+
50
+ ---
51
+
52
+ ## Usage Example
53
 
 
54
  ```python
55
  from transformers import AutoTokenizer, AutoModelForSequenceClassification
56
  import torch
57
 
58
+ tokenizer = AutoTokenizer.from_pretrained("HussainKAUST/saudi-eou-model")
59
+ model = AutoModelForSequenceClassification.from_pretrained("HussainKAUST/saudi-eou-model")
60
+
61
+ text = "ابي احجز موعد بس ..."
62
+ inputs = tokenizer(text, return_tensors="pt")
63
+
64
+ with torch.no_grad():
65
+ prob = torch.sigmoid(model(**inputs).logits).item()
66
 
67
+ print("EOU probability:", prob)