shiyemin2 commited on
Commit
0947cf2
ยท
verified ยท
1 Parent(s): 2104b60

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +142 -195
README.md CHANGED
@@ -1,199 +1,146 @@
1
  ---
2
  library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
-
11
-
12
- ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a ๐Ÿค— transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
  library_name: transformers
3
+ license: mit
4
+ datasets:
5
+ - maitrix-org/Voila-Benchmark
6
+ - maitrix-org/Voila-million-voice
7
+ language:
8
+ - en
9
+ - zh
10
+ - fr
11
+ - de
12
+ - ja
13
+ - ko
14
  ---
15
 
16
+ <p align="center">
17
+ <img src="https://voila.maitrix.org/static/images/logo.png" width="400"/><br/>
18
+ <b>Voila: <span style="color:#ca00f9">Voi</span>ce-<span style="color:#ca00f9">La</span>nguage Foundation Models</b><br/><br/>
19
+ ๐Ÿ’œ <a href="https://voila.maitrix.org/"><b>Voila</b></a> &nbsp&nbsp ๏ฝœ &nbsp&nbsp ๐Ÿ–ฅ๏ธ <a href="https://github.com/maitrix-org/Voila">GitHub</a> &nbsp&nbsp | &nbsp&nbsp๐Ÿค— <a href="https://huggingface.co/collections/maitrix-org/voila-67e0d96962c19f221fc73fa5">Hugging Face</a>&nbsp&nbsp | &nbsp&nbsp ๐Ÿ“‘ <a href="">Paper (Coming soon)</a> &nbsp&nbsp | &nbsp&nbsp ๐ŸŒ <a href="https://voila-demo.maitrix.org">Demo</a>
20
+ </p>
21
+
22
+ Voila is a groundbreaking family of large audio-language foundation models that revolutionizes human-AI interactions. Breaking away from the constraints of traditional voice AI systemsโ€”high latency, loss of vocal nuances, and mechanical responses, Voila employs an innovative end-to-end model design and a novel hierarchical Transformer architecture. This approach enables real-time, autonomous, and rich voice interactions, with latency as low as 195 ms, surpassing average human response times. Combining advanced voice and language modeling, Voila offers customizable, persona-driven engagements and excels in a range of audio tasks from ASR and TTS to speech translation across six languages. With the online [web demo](https://voila-demo.maitrix.org/), Voila invites you to explore a transformative, natural dialogue experience between human and AI.
23
+
24
+ # โœจ Highlights
25
+ - โญ High-fidelity, low-latency, real-time streaming audio processing
26
+ - โญ Effective integration of voice and language modeling capabilities
27
+ - โญ Millions of pre-built and custom voices, fast voice switching during conversation
28
+ - โญ Unified model for various audio tasks
29
+
30
+ # ๐ŸŽฅ Video Demo
31
+ <div align="center">
32
+ <video width="60%" controls>
33
+ <source src="https://voila.maitrix.org/static/videos/voila-demo.mp4" type="video/mp4">
34
+ Your browser does not support the video tag.
35
+ </video>
36
+ </div>
37
+
38
+ # ๐Ÿ”ฅ Latest News!!
39
+
40
+ * Mar 25, 2025: ๐Ÿ‘‹ We've released the inference code and model weights of Voila.
41
+
42
+ # โš™๏ธ Foundation Models
43
+
44
+ | Model | Description | Download Link |
45
+ |--------|-----------|-----------------|
46
+ |Voila-base|Voila base model|https://huggingface.co/maitrix-org/Voila-base|
47
+ |Voila-Chat|End-to-end audio chat model|https://huggingface.co/maitrix-org/Voila-chat|
48
+ |Voila-Autonomous (preview)|Full-duplex audio chat model|https://huggingface.co/maitrix-org/Voila-autonomous-preview|
49
+ |Voila-Audio-alpha|Empowering LLM with raw audio input|https://huggingface.co/maitrix-org/Voila-audio-alpha|
50
+ |Voila-Tokenizer|Audio tokenizer|https://huggingface.co/maitrix-org/Voila-Tokenizer|
51
+
52
+ ## Usage
53
+ ### CLI demo
54
+ ```shell
55
+ for model_name in "maitrix-org/Voila-audio-alpha" "maitrix-org/Voila-base" "maitrix-org/Voila-chat"; do
56
+ # Text chat
57
+ python infer.py \
58
+ --model-name ${model_name} \
59
+ --instruction "" \
60
+ --input-text "Hello" \
61
+ --task-type chat_tito
62
+ # Voice chat
63
+ python infer.py \
64
+ --model-name ${model_name} \
65
+ --instruction "" \
66
+ --input-audio "examples/test1.mp3" \
67
+ --task-type chat_aiao
68
+ done
69
+
70
+ # Autonomous mode
71
+ python infer.py \
72
+ --model-name "maitrix-org/Voila-autonomous-preview" \
73
+ --instruction "" \
74
+ --input-audio "examples/test_autonomous1.mp3" \
75
+ --task-type chat_aiao_auto
76
+ ```
77
+
78
+ ### Gradio demo
79
+ ```shell
80
+ python gradio_demo.py
81
+ ```
82
+
83
+ For more information, please refer to the [code repository](https://github.com/maitrix-org/Voila).
84
+
85
+ # ๐Ÿ“ Datasets
86
+ We publish the following two datasets: Voila Benchmark and Voila Voice Library. Voila-Benchmark is a novel speech evaluation benchmark, while Voila Voice Library provides millions of pre-built and customizable voices.
87
+
88
+ | Dataset | Description | Download Link |
89
+ |--------|-----------|-----------------|
90
+ |Voila Benchmark| Evaluation of Voila Benchmark | https://huggingface.co/datasets/maitrix-org/Voila-Benchmark |
91
+ |Voila Voice Library| Millons of pre-build voices | https://huggingface.co/datasets/maitrix-org/Voila-million-voice
92
+
93
+ # ๐Ÿ“Š Benchmark
94
+ ## 1. Voila Benchmark
95
+ We introduce a novel speech evaluation benchmark called the VoilaBenchmark. The Voila Benchmark is constructed by sampling from five widely used language model evaluation datasets: MMLU, MATH, OpenAI HumanEval, NQ-Open, and GSM8k. We compare our results with SpeechGPT and Moshi.
96
+ | Model | Voila Benchmark |
97
+ |-------|----------------|
98
+ |SpeechGPT| 13.29|
99
+ |Moshi | 11.45 |
100
+ |**Voila** | **30.56** |
101
+
102
+ _(higher is better)_
103
+
104
+ For detailed scores of Voila Benchmark on each specific domain, please refer to our paper (Section 5.1 "Evaluation of Voila Benchmark").
105
+ ## 2. Evaluation of ASR
106
+ As Voila supports multiple tasks, including Automatic Speech Recognition (ASR), Text-to-Speech(TTS), and spoken question answering, we also evaluate the performance of ASR and TTS.
107
+ For ASR, we assess performance on the LibriSpeech test-clean dataset, using Word Error Rate (WER) as our metric. Voila attains a word error rate (WER) of 4.8%, outperforming the 5.7% reported by Moshi. In scenarios where both models utilize LibriSpeech training data, Voila achieves an impressive WER of 2.7%.
108
+ | Model | LibriSpeech test-clean (WER) |
109
+ |-------|-----------------------|
110
+ |Whisper large v2|2.7|
111
+ |Whisper large v3|2.2|
112
+ |FastConformer|3.6|
113
+ |VoxtLM |2.7|
114
+ |Moshi |5.7|
115
+ |**Voila (w/o LibriSpeech train split)** |**4.8**|
116
+ |**Voila (with LibriSpeech train split)**|**2.7**|
117
+
118
+ _(lower is better)_
119
+
120
+ ## 3. Evaluation of TTS
121
+ For TTS, we follow the evaluation metrics proposed in Vall-E, which involves transcribing the generated audio using HuBERT-Large.
122
+ Voila once again leads with a WER of 3.2% (and 2.8% when using LibriSpeech training data).
123
+
124
+ | Model | LibriSpeech test-clean (WER) |
125
+ |-------|-----------------------|
126
+ |YourTTS |7.7|
127
+ |Vall-E|5.9|
128
+ |Moshi|4.7|
129
+ |**Voila (w/o LibriSpeech train split)** |**3.2**|
130
+ |**Voila (with LibriSpeech train split)** |**2.8**|
131
+
132
+ _(lower is better)_
133
+
134
+ # ๐Ÿ“ Citation
135
+ If you find our work helpful, please cite us.
136
+
137
+ ```
138
+ @article{voila2025,
139
+ author = {Yemin Shi, Yu Shu, Siwei Dong, Guangyi Liu, Jaward Sesay, Jingwen Li, Zhiting Hu},
140
+ title = {Voila: Voice-Language Foundation Models for Real-Time Autonomous Interaction and Voice Roleplay},
141
+ eprint={},
142
+ archivePrefix={arXiv},
143
+ primaryClass={cs.CL},
144
+ year = {2025}
145
+ }
146
+ ```