Update README.md

README.md

@@ -1,4 +1,5 @@
 ---
+
 title: FroxAI Flex-Audio
 emoji: 🦊
 colorFrom: purple
@@ -7,24 +8,42 @@ sdk: gradio
 sdk_version: 5.9.1
 app_file: app.py
 pinned: false
+pipeline_tag: text-to-speech
 license: other
----
+license_name: proprietary
+
+🦊 FroxAI — Flex-Audio
+
+Fine-tuned "XTTS-v2" (https://huggingface.co/coqui/XTTS-v2) text-to-speech model with real voice cloning, built by FroxAI.
+
+🎙️ Demo
+
+The repository includes a Gradio application in "app.py" with:
 
-# FroxAI — Flex-Audio
+- Text input
+- Language selection
+- Voice selection
+- Generated WAV output
+- Clickable demo examples
 
-Fine-tuned [XTTS-v2](https://huggingface.co/coqui/XTTS-v2) text-to-speech model with voice cloning, built by FroxAI.
+Run the demo
 
-## What's included
+python app.py
 
-- `model.pth` — fine-tuned weights
-- `config.json`, `vocab.json` — base model files required to reload (unchanged by fine-tuning)
-- `voice_refs/` — reference voice clips for cloning
-- `app.py` — Gradio demo (this Space)
-- `src/inference.py` — reusable inference code
+«Hugging Face: A model repository does not automatically execute "app.py" on its main page. The interactive model-page widget is available only when the model/task is supported by an Inference Provider. For this custom Gradio interface, deploy "app.py" as a Hugging Face Space to let visitors test it directly in a browser.»
 
-## Repo structure
+What's included
+
+- "model.pth" — fine-tuned model weights
+- "config.json" — base XTTS-v2 configuration required to reload the model
+- "vocab.json" — base model vocabulary required to reload the model
+- "voice_refs/" — reference voice clips for voice cloning
+- "app.py" — Gradio demo application
+- "src/inference.py" — reusable inference code
+- "requirements.txt" — Python dependencies
+
+📁 Repository structure
 
-```
 .
 ├── app.py
 ├── config.json
@@ -37,30 +56,34 @@ Fine-tuned [XTTS-v2](https://huggingface.co/coqui/XTTS-v2) text-to-speech model
     ├── slt.wav
     ├── bdl.wav
     └── ...
-```
 
-## Usage (outside this Space)
+🐍 Usage outside this Space
+
+The reusable inference interface can be used directly from Python:
 
-```python
 from src.inference import generate
 
 path = generate(
     text="Hello, this is Flex-Audio speaking.",
     language="en",
-    voice="slt",  # any filename (without .wav) in voice_refs/
+    voice="slt",  # filename without .wav from voice_refs/
 )
-```
 
-Or load the model directly:
+Load the model directly
 
-```python
 from TTS.tts.configs.xtts_config import XttsConfig
 from TTS.tts.models.xtts import Xtts
 
 config = XttsConfig()
 config.load_json("config.json")
+
 model = Xtts.init_from_config(config)
-model.load_checkpoint(config, checkpoint_dir=".", eval=True)
+model.load_checkpoint(
+    config,
+    checkpoint_dir=".",
+    eval=True,
+)
+
 model.cuda()
 
 outputs = model.synthesize(
@@ -69,12 +92,28 @@ outputs = model.synthesize(
     speaker_wav="voice_refs/slt.wav",
     language="en",
 )
-```
 
-## Languages
+🌍 Languages
+
+Flex-Audio supports 17 languages with real voice cloning, inherited from XTTS-v2:
+
+en, es, fr, de, it, pt, pl, tr, ru, nl, cs,
+ar, zh-cn, ja, hu, ko, hi
+
+🎤 Voices
+
+The "voice_refs/" directory contains the reference voice clips available for cloning.
+
+To use a voice, provide its filename without the ".wav" extension:
+
+voice="slt"
+
+For the complete list of available voices, see the files inside "voice_refs/".
+
+📜 License
 
-17 languages with real voice cloning (inherited from XTTS-v2): `en, es, fr, de, it, pt, pl, tr, ru, nl, cs, ar, zh-cn, ja, hu, ko, hi`.
+Proprietary / All Rights Reserved.
 
-## Voices
+No permission is granted to use, copy, modify, distribute, sublicense, sell, or deploy the model or its files except as expressly permitted by the copyright holder.
 
-See `voice_refs/` for the full list of cloneable reference voices included in this repo.
+The model also inherits the applicable terms of its base model. Check the "XTTS-v2 license" (https://huggingface.co/coqui/XTTS-v2) before using or redistributing this model.