v0.0.3 infer-cli ready

Author: SWivid

.gitignore

@@ -1,5 +1,6 @@
 # Customed
 results/
+tests/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -31,14 +31,30 @@ habibi-tts_infer-gradio
 
 ## CLI Usage
 ```bash
-# Single test with CLI
-# TODO
+# Default using the Unified model (recommanded)
+habibi-tts_infer-cli \
+--ref_audio "assets/MSA.mp3" \
+--ref_text "كان اللعيب حاضرًا في العديد من الأنشطة والفعاليات المرتبطة بكأس العالم، مما سمح للجماهير بالتفاعل معه والتقاط الصور التذكارية." \
+--gen_text "أهلًا، يبدو أن هناك بعض التعقيدات، لكن لا تقلق، سأرشدك بطريقة سلسة وواضحة خطوة بخطوة."
+
+# Assign the dialect ID, rather than inferred from given reference prompt (UNK, by default)
+# (best use matched dialectal content with ID: MSA, SAU, UAE, ALG, IRQ, EGY, IRQ, OMN, TUN, LEV, SDN, LBY)
+habibi-tts_infer-cli --dialect MSA
+
+# Alternatively, use `.toml` file to config, see `src/habibi_tts/infer/example.toml`
+habibi-tts_infer-cli -c YOUR_CUSTOM.toml
+
+# Check more CLI features with
+habibi-tts_infer-cli --help
 ```
 
+> [!NOTE]  
+> Some dialectal audio samples are provided under `src/habibi_tts/assets`, see the relevant [README.md](https://github.com/SWivid/Habibi-TTS/blob/main/src/habibi_tts/assets/README.md) for usage and more details.
+
 
 ## Benchmarking
 ```bash
-# TODO
+# SOON
 ```
 
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "habibi-tts"
-version = "0.0.2"
+version = "0.0.3"
 description = "Habibi: Laying the Open-Source Foundation of Unified-Dialectal Arabic Speech Synthesis"
 readme = "README.md"
 license = {text = "MIT License"}
@@ -22,4 +22,5 @@ dependencies = [
 Homepage = "https://github.com/SWivid/Habibi-TTS"
 
 [project.scripts]
+"habibi-tts_infer-cli" = "habibi_tts.infer.infer_cli:main"
 "habibi-tts_infer-gradio" = "habibi_tts.infer.infer_gradio:main"

src/habibi_tts/assets/README.md

@@ -1,14 +1,16 @@
 ## Reference Prompts Examples Used for Inference
 
-MP3 files are from ElevenLabs voice library, named same as Voice ID, WAV files are from [Habibi benchmark](https://huggingface.co/datasets/SWivid/Habibi).
+1. MP3 files are from ElevenLabs voice library, named same as Voice ID, WAV files are from [Habibi benchmark](https://huggingface.co/datasets/SWivid/Habibi). See the [Habibi paper](https://arxiv.org/abs/2601.13802) for more details.
+2. The terminology does not reflect any official classification for Arabic. Each sample is just for example, only reflects a part of the corresponding ID.
 
-### MSA
+
+### MSA (Modern Standard Arabic)
 ```bash
 # MSA.mp3 (JjTirzdD7T3GMLkwdd3a)
 "كان اللعيب حاضرًا في العديد من الأنشطة والفعاليات المرتبطة بكأس العالم، مما سمح للجماهير بالتفاعل معه والتقاط الصور التذكارية."
 ```
 
-### SAU
+### SAU (Najdi, Hijazi, Gulf, etc.)
 ```bash
 # Najdi.wav (6k_SBA_22_2-seg_410_975-416_518)
 "تكفى طمني انا اليوم ماني بنايم ولا هو بداخل عيني النوم الين اتطمن عليه."
@@ -20,32 +22,50 @@ MP3 files are from ElevenLabs voice library, named same as Voice ID, WAV files a
 "وين تو الناس متى تصحى ومتى تفطر وتغير يبيلك ساعة يعني بالله تروح الشغل الساعة عشره."
 ```
 
-### UAE
+### UAE (Emirati)
 ```bash
 # UAE.wav (13_segment_108)
 "قمنا نشتريها بشكل متكرر أو لما نلقى ستايل يعجبنا وحياناً هذا الستايل ما نحبه."
 ```
 
-### ALG
+### ALG (Algerian & Algerian Saharan)
 ```bash
 # ALG.wav (yCfWAGx6aTw-162)
 "أنيا هكا باغية ناكل هكا أني ن نشوف فيها الحاجة هذيكا."
 ```
 
-### IRQ
+### IRQ (Mesopotamian & North Mesopotamian)
 ```bash
 # IRQ.wav (P9zYhlu5pzw-613)
 "يعني ااا ما نقدر ناخذ وقت أكثر، ااا لأنه شروط كلش يحتاجلها وقت."
 ```
 
-### EGY
+### EGY (Egyptian, Saidi, etc.)
 ```bash
 # EGY.mp3 (IES4nrmZdUBHByLBde0P)
 "ايه الكلام. بقولك ايه. استخدم صوتي في المحادثات. استخدمه هيعجبك اوي."
 ```
 
-### MAR
+### MAR (Moroccan or Darija)
 ```bash
 # MAR.mp3 (OfGMGmhShO8iL9jCkXy8)
 "إذا بغيتي شي صوت باللهجة المغربية للإعلانات ديالك هذا أحسن واحد غادي تلقاه."
 ```
+
+### OMN (Omani, Dhofari, etc.)
+N/A
+
+### TUN (Tunisian)
+N/A
+
+### LEV (Levantine)
+N/A
+
+### SDN (Sudanese)
+N/A
+
+### LBY (Libyan)
+N/A
+
+### UNK (Unknown)
+N/A

src/habibi_tts/infer/example.toml

@@ -0,0 +1,12 @@
+# Unified | Specialized
+model = "Unified"
+# MSA | SAU | UAE | ALG | IRQ | EGY | IRQ | UNK
+dialect = "UNK"
+ref_audio = "assets/MSA.mp3"
+ref_text = "كان اللعيب حاضرًا في العديد من الأنشطة والفعاليات المرتبطة بكأس العالم، مما سمح للجماهير بالتفاعل معه والتقاط الصور التذكارية."
+gen_text = "أهلًا، يبدو أن هناك بعض التعقيدات، لكن لا تقلق، سأرشدك بطريقة سلسة وواضحة خطوة بخطوة."
+# File with text to generate. Ignores the text above.
+gen_file = ""
+remove_silence = false
+output_dir = "tests"
+output_file = "infer_cli_example.wav"