ainouche-abderahmane commited on
Commit
deafc66
·
verified ·
1 Parent(s): cc349f2

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +23 -6
README.md CHANGED
@@ -63,10 +63,16 @@ This preview will remain permanently published. The two future production models
63
 
64
  ## Usage
65
 
66
- ```python
67
- # Standalone Python inference with the shipped inference.py:
68
- # pip install torch torchaudio librosa soundfile huggingface_hub
 
 
 
 
 
69
 
 
70
  from inference import MatoubTTS
71
 
72
  tts = MatoubTTS.load()
@@ -204,9 +210,8 @@ The published file includes optimiser state and is resumable. A stripped inferen
204
  ## Reproduction
205
 
206
  ```bash
207
- make modal-matoub-pull # download checkpoint to artifacts/matoub/
208
- make release-matoub # stage for Hub release
209
- make push-matoub # upload to agbalu/Matoub-82M
210
  make infer-matoub TEXT="Azul fell-awen, amek i telliḍ taṣebḥit-a?"
211
  ```
212
 
@@ -226,6 +231,18 @@ His voice is inseparable from the survival of Kabyle as a spoken language in col
226
 
227
  The naming is homage; it implies no endorsement by anyone.
228
 
 
 
 
 
 
 
 
 
 
 
 
 
229
  ## Licence
230
 
231
  **Apache-2.0** on the weights and the code. The training data derives from Common Voice Kabyle (CC0); the Kokoro base weights are published under Apache-2.0. A permissive grant on weights makes no claim about the voice recordings they were trained on.
 
63
 
64
  ## Usage
65
 
66
+ **Not a `from_pretrained` model.** StyleTTS2 is not a `transformers` architecture and this is
67
+ a training checkpoint rather than an export, so the repository ships `inference.py` and that
68
+ is the interface. Download the repository and run from inside it:
69
+
70
+ ```bash
71
+ pip install torch torchaudio librosa soundfile huggingface_hub
72
+ hf download agbalu/Matoub-82M --local-dir Matoub-82M && cd Matoub-82M
73
+ ```
74
 
75
+ ```python
76
  from inference import MatoubTTS
77
 
78
  tts = MatoubTTS.load()
 
210
  ## Reproduction
211
 
212
  ```bash
213
+ make modal-matoub TASK=pull # download the checkpoint to artifacts/matoub/
214
+ make push REPO=matoub # restage and upload to agbalu/Matoub-82M
 
215
  make infer-matoub TEXT="Azul fell-awen, amek i telliḍ taṣebḥit-a?"
216
  ```
217
 
 
231
 
232
  The naming is homage; it implies no endorsement by anyone.
233
 
234
+ ## Citation
235
+
236
+ ```bibtex
237
+ @software{agbalu_matoub_2026,
238
+ title = {Matoub-82M: neural speech synthesis for Kabyle},
239
+ author = {AƔBALU},
240
+ year = {2026},
241
+ url = {https://huggingface.co/agbalu/Matoub-82M},
242
+ note = {StyleTTS2 fine-tune of Kokoro-82M on 21,953 restored Common Voice clips; preview}
243
+ }
244
+ ```
245
+
246
  ## Licence
247
 
248
  **Apache-2.0** on the weights and the code. The training data derives from Common Voice Kabyle (CC0); the Kokoro base weights are published under Apache-2.0. A permissive grant on weights makes no claim about the voice recordings they were trained on.