chua commited on
Commit
317c12d
·
1 Parent(s): e1c07e8

Update 0.1B ONNX runtime usage guide

Browse files
Files changed (1) hide show
  1. README.md +20 -15
README.md CHANGED
@@ -49,8 +49,10 @@ tokenizer, the packaged reference voice, and the optional FP16 encoder used to
49
  register reference voices.
50
 
51
  > **Model files only.** Inference, streaming service, and voice-registration
52
- > code live in the
53
- > [Audio8 TTS repository](https://github.com/Audio8-AI/Audio8_TTS/tree/master/onnx_runtime).
 
 
54
 
55
  > **Acknowledgments**
56
  >
@@ -132,19 +134,21 @@ conditioned on the slow hidden state and preceding codebooks.
132
 
133
  ## Quick Start
134
 
135
- Python 3.11 or newer is required. The current release is tested on macOS
136
- arm64 and Linux x86_64.
 
 
137
 
138
  ### 1. Download the code and model
139
 
140
  ```bash
141
  git clone https://github.com/Audio8-AI/Audio8_TTS.git
142
- cd Audio8_TTS/onnx_runtime
143
 
144
  python3 -m pip install -U "huggingface_hub[cli]"
145
- hf download Audio8/Audio8-TTS-Preview-0.1B-ONNX-INT8 --local-dir model
146
  bash setup.sh
147
- python3 scripts/register_default_voice.py # packaged fixed reference -> "default" voice
148
  ```
149
 
150
  The model files are stored at this Hugging Face repository's root. Downloading
@@ -170,7 +174,6 @@ bash run_infer.sh \
170
  --voice default \
171
  --text "这是一个零样本语音合成的中文测试,声音克隆效果怎么样?" \
172
  --max-new-tokens 256 \
173
- --greedy \
174
  --output outputs/example.wav
175
  ```
176
 
@@ -179,8 +182,11 @@ The command writes `outputs/example.wav` and `[10, T]` codec codes to
179
 
180
  ### 3. Register a reference voice
181
 
182
- Start the local service and open <http://127.0.0.1:8024>. Upload a 0.5-30
183
- second reference recording, its exact transcript, and a voice name.
 
 
 
184
 
185
  ```bash
186
  bash start_server.sh
@@ -215,7 +221,7 @@ curl http://127.0.0.1:8024/v1/audio/speech \
215
  ```
216
 
217
  See the complete
218
- [ONNX Runtime guide](https://github.com/Audio8-AI/Audio8_TTS/tree/master/onnx_runtime)
219
  for streaming output, configuration, memory management, and service controls.
220
 
221
  ## Evaluation
@@ -227,9 +233,9 @@ details.
227
 
228
  INT8 quantization can change sampled token sequences, so quality should be
229
  evaluated for each target language, voice, and deployment setting rather than
230
- assuming bit-for-bit equivalence with the source checkpoint. For
231
- bit-for-bit-faithful decoding, the repository also ships FP32 per-token graphs
232
- (see `onnx_runtime`).
233
 
234
  ## Limitations and Responsible Use
235
 
@@ -252,4 +258,3 @@ attribution details.
252
 
253
  We thank the Fish Audio team for publishing the DualAR architecture used in
254
  Fish Audio S2 Pro.
255
-
 
49
  register reference voices.
50
 
51
  > **Model files only.** Inference, streaming service, and voice-registration
52
+ > code live in the dedicated
53
+ > [0.1B INT8 ONNX Runtime](https://github.com/Audio8-AI/Audio8_TTS/tree/master/onnx_runtime_0_1b_int8).
54
+ > The older `onnx_runtime/` directory targets the incompatible 0.6B INT4
55
+ > graphs and must not be used with this model.
56
 
57
  > **Acknowledgments**
58
  >
 
134
 
135
  ## Quick Start
136
 
137
+ Python 3.10 or newer is required. The runtime uses ONNX Runtime's
138
+ `CPUExecutionProvider`; platform-specific ONNX Runtime wheels may be needed on
139
+ devices such as Jetson. The current release is tested on macOS arm64 and Linux
140
+ x86_64.
141
 
142
  ### 1. Download the code and model
143
 
144
  ```bash
145
  git clone https://github.com/Audio8-AI/Audio8_TTS.git
146
+ cd Audio8_TTS/onnx_runtime_0_1b_int8
147
 
148
  python3 -m pip install -U "huggingface_hub[cli]"
149
+ hf download Audio8/audio8-TTS-0.1B-ONNX-INT8 --local-dir model
150
  bash setup.sh
151
+ "$PWD/.venv/bin/python" scripts/register_default_voice.py # packaged reference -> "default" voice
152
  ```
153
 
154
  The model files are stored at this Hugging Face repository's root. Downloading
 
174
  --voice default \
175
  --text "这是一个零样本语音合成的中文测试,声音克隆效果怎么样?" \
176
  --max-new-tokens 256 \
 
177
  --output outputs/example.wav
178
  ```
179
 
 
182
 
183
  ### 3. Register a reference voice
184
 
185
+ Start the local service and open <http://127.0.0.1:8024>. The page provides text
186
+ generation, voice selection, WAV playback/download, reference-voice
187
+ registration, memory status, and runtime reload. The Swagger API documentation
188
+ is available at <http://127.0.0.1:8024/docs>. Upload a 0.5-30 second reference
189
+ recording, its exact transcript, and a voice name to register a new voice.
190
 
191
  ```bash
192
  bash start_server.sh
 
221
  ```
222
 
223
  See the complete
224
+ [0.1B ONNX Runtime guide](https://github.com/Audio8-AI/Audio8_TTS/tree/master/onnx_runtime_0_1b_int8)
225
  for streaming output, configuration, memory management, and service controls.
226
 
227
  ## Evaluation
 
233
 
234
  INT8 quantization can change sampled token sequences, so quality should be
235
  evaluated for each target language, voice, and deployment setting rather than
236
+ assuming bit-for-bit equivalence with the source checkpoint. This repository
237
+ contains the 0.1B INT8 graphs; use the dedicated runtime linked above when
238
+ running them.
239
 
240
  ## Limitations and Responsible Use
241
 
 
258
 
259
  We thank the Fish Audio team for publishing the DualAR architecture used in
260
  Fish Audio S2 Pro.