Approximetal commited on
Commit
1f053ff
·
verified ·
1 Parent(s): f36e46d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -117
README.md CHANGED
@@ -1,119 +1,10 @@
1
- # LEMAS-TTS Gradio Demo (Hugging Face Space)
2
-
3
- This folder is a **clean, inference-only** version of LEMAS-TTS, organized for easy deployment on **Hugging Face Spaces**.
4
-
5
- It keeps only:
6
- - the inference models & configs (`lemas_tts`)
7
- - pretrained checkpoints and vocab (`pretrained_models`)
8
- - the bundled UVR5 denoiser (`uvr5`)
9
- - a Gradio web UI (`inference_gradio.py`, `app.py`)
10
-
11
  ---
12
-
13
- ## 1. Features
14
-
15
- - Zero-shot TTS: clone voice from a reference audio + reference text
16
- - Multilingual text input (Chinese / English / ES / IT / PT / DE, etc.)
17
- - Optional UVR5-based reference denoising
18
- - Two custom LEMAS checkpoints:
19
- - `multilingual_prosody_custom`
20
- - `multilingual_acc_grl_custom`
21
-
22
  ---
23
-
24
- ## 2. Project Structure
25
-
26
- ```text
27
- LEMAS-TTS_gradio/
28
- app.py # HF Space entrypoint (Gradio Blocks)
29
- inference_gradio.py # Full Gradio UI & logic
30
- requirements.txt # Minimal runtime dependencies
31
-
32
- lemas_tts/ # Core LEMAS-TTS package (inference only)
33
- api.py # F5TTS API (used by the UI)
34
- configs/ # Model configs (F5TTS / E2TTS)
35
- infer/ # Inference utilities & text frontend
36
- model/ # DiT backbone, utils, etc.
37
-
38
- pretrained_models/ # All local assets needed for inference
39
- ckpts/
40
- F5TTS_v1_Base_vocos_custom_multilingual_prosody/model_2698000.pt
41
- F5TTS_v1_Base_vocos_custom_multilingual_acc_grl/model_2680000.pt
42
- prosody_encoder/...
43
- vocos-mel-24khz/...
44
- data/
45
- multilingual_prosody_custom/vocab.txt
46
- multilingual_acc_grl_custom/vocab.txt
47
- test_examples/*.wav # Demo audios used in the UI
48
- uvr5/
49
- models/MDX_Net_Models/model_data/*.onnx, *.json
50
-
51
- uvr5/ # Bundled UVR5 implementation for denoising
52
- ```
53
-
54
- `lemas_tts.api.F5TTS` automatically resolves `pretrained_models/` based on the repo layout, so no extra path configuration is required.
55
-
56
- ---
57
-
58
- ## 3. How to Run Locally
59
-
60
- ```bash
61
- cd LEMAS-TTS_gradio
62
- pip install -r requirements.txt
63
- python app.py
64
- ```
65
-
66
- Then open the printed URL (default `http://127.0.0.1:7860`) in your browser.
67
-
68
- ---
69
-
70
- ## 4. Hugging Face Space Setup
71
-
72
- 1. Create a new Space (type: **Gradio**).
73
- 2. Upload the contents of `LEMAS-TTS_gradio/` to the Space repo:
74
- - `app.py`
75
- - `inference_gradio.py`
76
- - `requirements.txt`
77
- - `lemas_tts/`
78
- - `pretrained_models/`
79
- - `uvr5/`
80
- 3. In the Space settings, choose a GPU hardware profile (the model is heavy).
81
- 4. The Space will automatically run `app.py` and launch the Gradio Blocks named `app`.
82
-
83
- No extra arguments are needed; all paths are relative inside the repo.
84
-
85
- ---
86
-
87
- ## 5. Usage Tips
88
-
89
- - **Reference Text** should match the reference audio roughly in content and language for best voice cloning.
90
- - **Denoise**:
91
- - Turn on if your reference audio is noisy; it runs UVR5 on CPU.
92
- - Turn off if the reference is already clean (saves time).
93
- - **Seed**:
94
- - `-1` → random seed
95
- - Any other integer → reproducible output
96
-
97
- ---
98
-
99
- ## 6. 中文说明(简要)
100
-
101
- 这个目录是专门为 **Hugging Face Space** 打包的 **推理版 LEMAS-TTS**:
102
-
103
- - 只保留推理相关代码(`lemas_tts`)、预训练模型(`pretrained_models`)和 UVR5 去噪模块(`uvr5`)
104
- - Gradio 入口为 `app.py`,内部调用 `inference_gradio.py` 里的 `app`(一个 `gr.Blocks` 界面)
105
- - `pretrained_models/` 下已经包含:
106
- - 自定义多语种 prosody / accent GRL 的 finetune 权重
107
- - vocoder(`vocos-mel-24khz`)
108
- - prosody encoder
109
- - 以及示例语音 `test_examples/*.wav`
110
-
111
- 在本地或 Space 中运行步骤:
112
-
113
- ```bash
114
- pip install -r requirements.txt
115
- python app.py
116
- ```
117
-
118
- 然后在浏览器中打开提示的链接即可使用零样本 TTS Demo。
119
-
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: LEMAS-Edit
3
+ emoji:
4
+ colorFrom: indigo
5
+ colorTo: green
6
+ sdk: gradio
7
+ sdk_version: "5.10.0"
8
+ app_file: app.py
9
+ pinned: false
 
 
10
  ---