Ezi commited on
Commit
bc779c1
1 Parent(s): 6b1b5aa

restructuring the MC

Browse files

Hi! This PR has a preliminary model card, based on the format we are using as part of our effort to standardisee model cards at Hugging Face. Please see this [doc of an annotated model card](https://huggingface.co/docs/hub/model-card-annotated)

Files changed (1) hide show
  1. README.md +172 -5
README.md CHANGED
@@ -15,7 +15,7 @@ This model was introduced in [SpeechT5: Unified-Modal Encoder-Decoder Pre-Traini
15
 
16
  SpeechT5 was first released in [this repository](https://github.com/microsoft/SpeechT5/), [original weights](https://huggingface.co/mechanicalsea/speecht5-tts). The license used is [MIT](https://github.com/microsoft/SpeechT5/blob/main/LICENSE).
17
 
18
- Disclaimer: The team releasing SpeechT5 did not write a model card for this model so this model card has been written by the Hugging Face team.
19
 
20
  ## Model Description
21
 
@@ -25,6 +25,59 @@ Leveraging large-scale unlabeled speech and text data, we pre-train SpeechT5 to
25
 
26
  Extensive evaluations show the superiority of the proposed SpeechT5 framework on a wide variety of spoken language processing tasks, including automatic speech recognition, speech synthesis, speech translation, voice conversion, speech enhancement, and speaker identification.
27
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
  ## How to Get Started With the Model
29
 
30
  Use the code below to convert text into a mono 16 kHz speech waveform.
@@ -49,13 +102,106 @@ speech = model.generate_speech(inputs["input_ids"], speaker_embeddings, vocoder=
49
  sf.write("speech.wav", speech.numpy(), samplerate=16000)
50
  ```
51
 
52
- ## Intended Uses & Limitations
53
 
54
- You can use this model for speech synthesis. See the [model hub](https://huggingface.co/models?search=speecht5) to look for fine-tuned versions on a task that interests you.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
55
 
56
- Currently, both the feature extractor and model support PyTorch.
57
 
58
- ## Citation
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
59
 
60
  **BibTeX:**
61
 
@@ -69,3 +215,24 @@ Currently, both the feature extractor and model support PyTorch.
69
  pages={5723--5738},
70
  }
71
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
15
 
16
  SpeechT5 was first released in [this repository](https://github.com/microsoft/SpeechT5/), [original weights](https://huggingface.co/mechanicalsea/speecht5-tts). The license used is [MIT](https://github.com/microsoft/SpeechT5/blob/main/LICENSE).
17
 
18
+
19
 
20
  ## Model Description
21
 
 
25
 
26
  Extensive evaluations show the superiority of the proposed SpeechT5 framework on a wide variety of spoken language processing tasks, including automatic speech recognition, speech synthesis, speech translation, voice conversion, speech enhancement, and speaker identification.
27
 
28
+ - **Developed by:** Junyi Ao, Rui Wang, Long Zhou, Chengyi Wang, Shuo Ren, Yu Wu, Shujie Liu, Tom Ko, Qing Li, Yu Zhang, Zhihua Wei, Yao Qian, Jinyu Li, Furu Wei.
29
+ - **Shared by [optional]:** Mathijs Hollemans
30
+ - **Model type:** text-to-speech
31
+ - **Language(s) (NLP):** [More Information Needed]
32
+ - **License:** [MIT](https://github.com/microsoft/SpeechT5/blob/main/LICENSE
33
+ - **Finetuned from model [optional]:** [More Information Needed]
34
+
35
+
36
+ ## Model Sources [optional]
37
+
38
+ <!-- Provide the basic links for the model. -->
39
+
40
+ - **Repository:** [ttps://github.com/microsoft/SpeechT5/]
41
+ - **Paper:** [https://arxiv.org/pdf/2110.07205.pdf]
42
+ - **Blog Post:** [https://huggingface.co/blog/speecht5]
43
+ - **Demo:** [https://huggingface.co/spaces/Matthijs/speecht5-tts-demo]
44
+
45
+
46
+ # Uses
47
+
48
+ <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
49
+
50
+ ## Direct Use
51
+
52
+ <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
53
+
54
+ You can use this model for speech synthesis. See the [model hub](https://huggingface.co/models?search=speecht5) to look for fine-tuned versions on a task that interests you.
55
+
56
+ ## Downstream Use [optional]
57
+
58
+ <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
59
+
60
+ [More Information Needed]
61
+
62
+ ## Out-of-Scope Use
63
+
64
+ <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
65
+
66
+ [More Information Needed]
67
+
68
+ # Bias, Risks, and Limitations
69
+
70
+ <!-- This section is meant to convey both technical and sociotechnical limitations. -->
71
+
72
+ [More Information Needed]
73
+
74
+ ## Recommendations
75
+
76
+ <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
77
+
78
+ Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
79
+
80
+
81
  ## How to Get Started With the Model
82
 
83
  Use the code below to convert text into a mono 16 kHz speech waveform.
 
102
  sf.write("speech.wav", speech.numpy(), samplerate=16000)
103
  ```
104
 
105
+ # Training Details
106
 
107
+ ## Training Data
108
+
109
+ <!-- This should link to a Data 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. -->
110
+
111
+ LibriTTS
112
+
113
+ ## Training Procedure
114
+
115
+ <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
116
+
117
+ ### Preprocessing [optional]
118
+
119
+ Leveraging large-scale unlabeled speech and text data, we pre-train SpeechT5 to learn a unified-modal representation, hoping to improve the modeling capability for both speech and text.
120
+
121
+
122
+ ### Training hyperparameters
123
+ - **Precision:** [More Information Needed] <!--fp16, bf16, fp8, fp32 -->
124
+ - **Regime:** [More Information Needed] <!--mixed precision or not -->
125
+
126
+ ### Speeds, Sizes, Times [optional]
127
+
128
+ <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
129
+
130
+ [More Information Needed]
131
+
132
+ # Evaluation
133
+
134
+ <!-- This section describes the evaluation protocols and provides the results. -->
135
+
136
+ ## Testing Data, Factors & Metrics
137
+
138
+ ### Testing Data
139
+
140
+ <!-- This should link to a Data Card if possible. -->
141
 
142
+ [More Information Needed]
143
 
144
+ ### Factors
145
+
146
+ <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
147
+
148
+ [More Information Needed]
149
+
150
+ ### Metrics
151
+
152
+ <!-- These are the evaluation metrics being used, ideally with a description of why. -->
153
+
154
+ [More Information Needed]
155
+
156
+ ## Results
157
+
158
+ [More Information Needed]
159
+
160
+ ### Summary
161
+
162
+
163
+
164
+ # Model Examination [optional]
165
+
166
+ <!-- Relevant interpretability work for the model goes here -->
167
+
168
+ Extensive evaluations show the superiority of the proposed SpeechT5 framework on a wide variety of spoken language processing tasks, including automatic speech recognition, speech synthesis, speech translation, voice conversion, speech enhancement, and speaker identification.
169
+
170
+ # Environmental Impact
171
+
172
+ <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
173
+
174
+ 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).
175
+
176
+ - **Hardware Type:** [More Information Needed]
177
+ - **Hours used:** [More Information Needed]
178
+ - **Cloud Provider:** [More Information Needed]
179
+ - **Compute Region:** [More Information Needed]
180
+ - **Carbon Emitted:** [More Information Needed]
181
+
182
+ # Technical Specifications [optional]
183
+
184
+ ## Model Architecture and Objective
185
+
186
+ The SpeechT5 framework consists of a shared encoder-decoder network and six modal-specific (speech/text) pre/post-nets.
187
+
188
+ After preprocessing the input speech/text through the pre-nets, the shared encoder-decoder network models the sequence-to-sequence transformation, and then the post-nets generate the output in the speech/text modality based on the output of the decoder.
189
+
190
+ ## Compute Infrastructure
191
+
192
+ [More Information Needed]
193
+
194
+ ### Hardware
195
+
196
+ [More Information Needed]
197
+
198
+ ### Software
199
+
200
+ [More Information Needed]
201
+
202
+ # Citation [optional]
203
+
204
+ <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
205
 
206
  **BibTeX:**
207
 
 
215
  pages={5723--5738},
216
  }
217
  ```
218
+
219
+ # Glossary [optional]
220
+
221
+ <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
222
+
223
+ - **text-to-speech** to synthesize audio
224
+
225
+ # More Information [optional]
226
+
227
+ [More Information Needed]
228
+
229
+ # Model Card Authors [optional]
230
+
231
+ Disclaimer: The team releasing SpeechT5 did not write a model card for this model so this model card has been written by the Hugging Face team.
232
+
233
+ # Model Card Contact
234
+
235
+ [More Information Needed]
236
+
237
+
238
+