reach-vb HF staff commited on
Commit
c2a7291
1 Parent(s): a01fb33

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +188 -0
README.md CHANGED
@@ -1,3 +1,191 @@
1
  ---
2
  license: unknown
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: unknown
3
  ---
4
+
5
+ # SeamlessM4T v2
6
+
7
+ SeamlessM4T is our foundational all-in-one **M**assively **M**ultilingual and **M**ultimodal **M**achine **T**ranslation model delivering high-quality translation for speech and text in nearly 100 languages.
8
+
9
+ SeamlessM4T models support the tasks of:
10
+ - Speech-to-speech translation (S2ST)
11
+ - Speech-to-text translation (S2TT)
12
+ - Text-to-speech translation (T2ST)
13
+ - Text-to-text translation (T2TT)
14
+ - Automatic speech recognition (ASR).
15
+
16
+ :star2: We are releasing SemalessM4T v2, an updated version with our novel *UnitY2* architecture.
17
+ This new model improves over SeamlessM4T v1 in quality as well as inference speed in speech generation tasks.
18
+
19
+ The v2 version of SeamlessM4T is a multitask adaptation of our novel *UnitY2* architecture.
20
+ *Unity2* with its hierarchical character-to-unit upsampling and non-autoregressive text-to-unit decoding considerably improves over SeamlessM4T v1 in quality and inference speed.
21
+
22
+
23
+ ![SeamlessM4T architectures](images/seamlessm4t_arch.svg)
24
+
25
+ ## SeamlessM4T models
26
+ | Model Name | #params | checkpoint | metrics |
27
+ | ------------------ | ------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
28
+ | SeamlessM4T-Large v2 | 2.3B | [🤗 Model card](https://huggingface.co/facebook/??) - [checkpoint](?) | [metrics](https://dl.fbaipublicfiles.com/seamless/metrics/seamlessM4T_large_v2.zip) |
29
+ | SeamlessM4T-Large (v1) | 2.3B | [🤗 Model card](https://huggingface.co/facebook/seamless-m4t-large) - [checkpoint](https://huggingface.co/facebook/seamless-m4t-large/resolve/main/multitask_unity_large.pt) | [metrics](https://dl.fbaipublicfiles.com/seamless/metrics/seamlessM4T_large.zip) |
30
+ | SeamlessM4T-Medium (v1) | 1.2B | [🤗 Model card](https://huggingface.co/facebook/seamless-m4t-medium) - [checkpoint](https://huggingface.co/facebook/seamless-m4t-medium/resolve/main/multitask_unity_medium.pt) | [metrics](https://dl.fbaipublicfiles.com/seamless/metrics/seamlessM4T_medium.zip) |
31
+
32
+ We provide the extensive evaluation results of seamlessM4T-Large and SeamlessM4T-Medium reported in the paper (as averages) in the `metrics` files above.
33
+
34
+ The evaluation data ids for FLEURS, CoVoST2 and CVSS-C can be found [here](https://dl.fbaipublicfiles.com/seamless/metrics/evaluation_data_ids.zip)
35
+
36
+
37
+ ## Evaluating SeamlessM4T models
38
+ To reproduce our results or to evaluate using the same metrics over your own test sets, please check out the [Evaluation README here](../../src/seamless_communication/cli/m4t/evaluate/README.md).
39
+
40
+
41
+ ## Finetuning SeamlessM4T models
42
+ Please check out the [Finetuning README here](../../src/seamless_communication/cli/m4t/finetune/README.md).
43
+
44
+ ## Supported Languages:
45
+
46
+ Listed below, are the languages supported by SeamlessM4T-large (v1/v2).
47
+ The `source` column specifies whether a language is supported as source speech (`Sp`) and/or source text (`Tx`).
48
+ The `target` column specifies whether a language is supported as target speech (`Sp`) and/or target text (`Tx`).
49
+
50
+
51
+ | code | language | script | Source | Target |
52
+ | ---- | ---------------------- | ---------- | ------ | ------ |
53
+ | afr | Afrikaans | Latn | Sp, Tx | Tx |
54
+ | amh | Amharic | Ethi | Sp, Tx | Tx |
55
+ | arb | Modern Standard Arabic | Arab | Sp, Tx | Sp, Tx |
56
+ | ary | Moroccan Arabic | Arab | Sp, Tx | Tx |
57
+ | arz | Egyptian Arabic | Arab | Sp, Tx | Tx |
58
+ | asm | Assamese | Beng | Sp, Tx | Tx |
59
+ | ast | Asturian | Latn | Sp | \-- |
60
+ | azj | North Azerbaijani | Latn | Sp, Tx | Tx |
61
+ | bel | Belarusian | Cyrl | Sp, Tx | Tx |
62
+ | ben | Bengali | Beng | Sp, Tx | Sp, Tx |
63
+ | bos | Bosnian | Latn | Sp, Tx | Tx |
64
+ | bul | Bulgarian | Cyrl | Sp, Tx | Tx |
65
+ | cat | Catalan | Latn | Sp, Tx | Sp, Tx |
66
+ | ceb | Cebuano | Latn | Sp, Tx | Tx |
67
+ | ces | Czech | Latn | Sp, Tx | Sp, Tx |
68
+ | ckb | Central Kurdish | Arab | Sp, Tx | Tx |
69
+ | cmn | Mandarin Chinese | Hans | Sp, Tx | Sp, Tx |
70
+ | cmn_Hant | Mandarin Chinese | Hant | Sp, Tx | Sp, Tx |
71
+ | cym | Welsh | Latn | Sp, Tx | Sp, Tx |
72
+ | dan | Danish | Latn | Sp, Tx | Sp, Tx |
73
+ | deu | German | Latn | Sp, Tx | Sp, Tx |
74
+ | ell | Greek | Grek | Sp, Tx | Tx |
75
+ | eng | English | Latn | Sp, Tx | Sp, Tx |
76
+ | est | Estonian | Latn | Sp, Tx | Sp, Tx |
77
+ | eus | Basque | Latn | Sp, Tx | Tx |
78
+ | fin | Finnish | Latn | Sp, Tx | Sp, Tx |
79
+ | fra | French | Latn | Sp, Tx | Sp, Tx |
80
+ | fuv | Nigerian Fulfulde | Latn | Sp, Tx | Tx |
81
+ | gaz | West Central Oromo | Latn | Sp, Tx | Tx |
82
+ | gle | Irish | Latn | Sp, Tx | Tx |
83
+ | glg | Galician | Latn | Sp, Tx | Tx |
84
+ | guj | Gujarati | Gujr | Sp, Tx | Tx |
85
+ | heb | Hebrew | Hebr | Sp, Tx | Tx |
86
+ | hin | Hindi | Deva | Sp, Tx | Sp, Tx |
87
+ | hrv | Croatian | Latn | Sp, Tx | Tx |
88
+ | hun | Hungarian | Latn | Sp, Tx | Tx |
89
+ | hye | Armenian | Armn | Sp, Tx | Tx |
90
+ | ibo | Igbo | Latn | Sp, Tx | Tx |
91
+ | ind | Indonesian | Latn | Sp, Tx | Sp, Tx |
92
+ | isl | Icelandic | Latn | Sp, Tx | Tx |
93
+ | ita | Italian | Latn | Sp, Tx | Sp, Tx |
94
+ | jav | Javanese | Latn | Sp, Tx | Tx |
95
+ | jpn | Japanese | Jpan | Sp, Tx | Sp, Tx |
96
+ | kam | Kamba | Latn | Sp | \-- |
97
+ | kan | Kannada | Knda | Sp, Tx | Tx |
98
+ | kat | Georgian | Geor | Sp, Tx | Tx |
99
+ | kaz | Kazakh | Cyrl | Sp, Tx | Tx |
100
+ | kea | Kabuverdianu | Latn | Sp | \-- |
101
+ | khk | Halh Mongolian | Cyrl | Sp, Tx | Tx |
102
+ | khm | Khmer | Khmr | Sp, Tx | Tx |
103
+ | kir | Kyrgyz | Cyrl | Sp, Tx | Tx |
104
+ | kor | Korean | Kore | Sp, Tx | Sp, Tx |
105
+ | lao | Lao | Laoo | Sp, Tx | Tx |
106
+ | lit | Lithuanian | Latn | Sp, Tx | Tx |
107
+ | ltz | Luxembourgish | Latn | Sp | \-- |
108
+ | lug | Ganda | Latn | Sp, Tx | Tx |
109
+ | luo | Luo | Latn | Sp, Tx | Tx |
110
+ | lvs | Standard Latvian | Latn | Sp, Tx | Tx |
111
+ | mai | Maithili | Deva | Sp, Tx | Tx |
112
+ | mal | Malayalam | Mlym | Sp, Tx | Tx |
113
+ | mar | Marathi | Deva | Sp, Tx | Tx |
114
+ | mkd | Macedonian | Cyrl | Sp, Tx | Tx |
115
+ | mlt | Maltese | Latn | Sp, Tx | Sp, Tx |
116
+ | mni | Meitei | Beng | Sp, Tx | Tx |
117
+ | mya | Burmese | Mymr | Sp, Tx | Tx |
118
+ | nld | Dutch | Latn | Sp, Tx | Sp, Tx |
119
+ | nno | Norwegian Nynorsk | Latn | Sp, Tx | Tx |
120
+ | nob | Norwegian Bokmål | Latn | Sp, Tx | Tx |
121
+ | npi | Nepali | Deva | Sp, Tx | Tx |
122
+ | nya | Nyanja | Latn | Sp, Tx | Tx |
123
+ | oci | Occitan | Latn | Sp | \-- |
124
+ | ory | Odia | Orya | Sp, Tx | Tx |
125
+ | pan | Punjabi | Guru | Sp, Tx | Tx |
126
+ | pbt | Southern Pashto | Arab | Sp, Tx | Tx |
127
+ | pes | Western Persian | Arab | Sp, Tx | Sp, Tx |
128
+ | pol | Polish | Latn | Sp, Tx | Sp, Tx |
129
+ | por | Portuguese | Latn | Sp, Tx | Sp, Tx |
130
+ | ron | Romanian | Latn | Sp, Tx | Sp, Tx |
131
+ | rus | Russian | Cyrl | Sp, Tx | Sp, Tx |
132
+ | slk | Slovak | Latn | Sp, Tx | Sp, Tx |
133
+ | slv | Slovenian | Latn | Sp, Tx | Tx |
134
+ | sna | Shona | Latn | Sp, Tx | Tx |
135
+ | snd | Sindhi | Arab | Sp, Tx | Tx |
136
+ | som | Somali | Latn | Sp, Tx | Tx |
137
+ | spa | Spanish | Latn | Sp, Tx | Sp, Tx |
138
+ | srp | Serbian | Cyrl | Sp, Tx | Tx |
139
+ | swe | Swedish | Latn | Sp, Tx | Sp, Tx |
140
+ | swh | Swahili | Latn | Sp, Tx | Sp, Tx |
141
+ | tam | Tamil | Taml | Sp, Tx | Tx |
142
+ | tel | Telugu | Telu | Sp, Tx | Sp, Tx |
143
+ | tgk | Tajik | Cyrl | Sp, Tx | Tx |
144
+ | tgl | Tagalog | Latn | Sp, Tx | Sp, Tx |
145
+ | tha | Thai | Thai | Sp, Tx | Sp, Tx |
146
+ | tur | Turkish | Latn | Sp, Tx | Sp, Tx |
147
+ | ukr | Ukrainian | Cyrl | Sp, Tx | Sp, Tx |
148
+ | urd | Urdu | Arab | Sp, Tx | Sp, Tx |
149
+ | uzn | Northern Uzbek | Latn | Sp, Tx | Sp, Tx |
150
+ | vie | Vietnamese | Latn | Sp, Tx | Sp, Tx |
151
+ | xho | Xhosa | Latn | Sp | \-- |
152
+ | yor | Yoruba | Latn | Sp, Tx | Tx |
153
+ | yue | Cantonese | Hant | Sp, Tx | Tx |
154
+ | zlm | Colloquial Malay | Latn | Sp | \-- |
155
+ | zsm | Standard Malay | Latn | Tx | Tx |
156
+ | zul | Zulu | Latn | Sp, Tx | Tx |
157
+
158
+
159
+ Note that seamlessM4T-medium supports 200 languages in the text modality, and is based on NLLB-200 (see full list in [asset card](src/seamless_communication/cards/unity_nllb-200.yaml))
160
+
161
+ ## Citation
162
+ For *UnitY*, please cite :
163
+ ```bibtex
164
+ @inproceedings{inaguma-etal-2023-unity,
165
+ title="{U}nit{Y}: Two-pass Direct Speech-to-speech Translation with Discrete Units",
166
+ author="Inaguma, Hirofumi and Popuri, Sravya and Kulikov, Ilia and Chen, Peng-Jen and Wang, Changhan and Chung, Yu-An and Tang, Yun and Lee, Ann and Watanabe, Shinji and Pino, Juan",
167
+ booktitle="Proceedings of the 61st Annual Meeting of the Association for Computational Linguistics (Volume 1: Long Papers)",
168
+ year="2023",
169
+ url="https://aclanthology.org/2023.acl-long.872",
170
+ }
171
+ ```
172
+
173
+ For SeamlessM4T v1, please cite :
174
+ ```bibtex
175
+ @article{seamlessm4t2023,
176
+ title={SeamlessM4T: Massively Multilingual \& Multimodal Machine Translation},
177
+ author={{Seamless Communication}, Lo\"{i}c Barrault, Yu-An Chung, Mariano Cora Meglioli, David Dale, Ning Dong, Paul-Ambroise Duquenne, Hady Elsahar, Hongyu Gong, Kevin Heffernan, John Hoffman, Christopher Klaiber, Pengwei Li, Daniel Licht, Jean Maillard, Alice Rakotoarison, Kaushik Ram Sadagopan, Guillaume Wenzek, Ethan Ye, Bapi Akula, Peng-Jen Chen, Naji El Hachem, Brian Ellis, Gabriel Mejia Gonzalez, Justin Haaheim, Prangthip Hansanti, Russ Howes, Bernie Huang, Min-Jae Hwang, Hirofumi Inaguma, Somya Jain, Elahe Kalbassi, Amanda Kallet, Ilia Kulikov, Janice Lam, Daniel Li, Xutai Ma, Ruslan Mavlyutov, Benjamin Peloquin, Mohamed Ramadan, Abinesh Ramakrishnan, Anna Sun, Kevin Tran, Tuan Tran, Igor Tufanov, Vish Vogeti, Carleigh Wood, Yilin Yang, Bokai Yu, Pierre Andrews, Can Balioglu, Marta R. Costa-juss\`{a} \footnotemark[3], Onur \,{C}elebi,Maha Elbayad,Cynthia Gao, Francisco Guzm\'an, Justine Kao, Ann Lee, Alexandre Mourachko, Juan Pino, Sravya Popuri, Christophe Ropers, Safiyyah Saleem, Holger Schwenk, Paden Tomasello, Changhan Wang, Jeff Wang, Skyler Wang},
178
+ journal={ArXiv},
179
+ year={2023}
180
+ }
181
+ ```
182
+
183
+ For SeamlessM4T v2, please cite :
184
+ ```bibtex
185
+ @inproceedings{seamless2023,
186
+ title="Seamless: Multilingual Expressive and Streaming Speech Translation",
187
+ author="{Seamless Communication}, Lo{\"i}c Barrault, Yu-An Chung, Mariano Coria Meglioli, David Dale, Ning Dong, Mark Duppenthaler, Paul-Ambroise Duquenne, Brian Ellis, Hady Elsahar, Justin Haaheim, John Hoffman, Min-Jae Hwang, Hirofumi Inaguma, Christopher Klaiber, Ilia Kulikov, Pengwei Li, Daniel Licht, Jean Maillard, Ruslan Mavlyutov, Alice Rakotoarison, Kaushik Ram Sadagopan, Abinesh Ramakrishnan, Tuan Tran, Guillaume Wenzek, Yilin Yang, Ethan Ye, Ivan Evtimov, Pierre Fernandez, Cynthia Gao, Prangthip Hansanti, Elahe Kalbassi, Amanda Kallet, Artyom Kozhevnikov, Gabriel Mejia, Robin San Roman, Christophe Touret, Corinne Wong, Carleigh Wood, Bokai Yu, Pierre Andrews, Can Balioglu, Peng-Jen Chen, Marta R. Costa-juss{\`a}, Maha Elbayad, Hongyu Gong, Francisco Guzm{\'a}n, Kevin Heffernan, Somya Jain, Justine Kao, Ann Lee, Xutai Ma, Alex Mourachko, Benjamin Peloquin, Juan Pino, Sravya Popuri, Christophe Ropers, Safiyyah Saleem, Holger Schwenk, Anna Sun, Paden Tomasello, Changhan Wang, Jeff Wang, Skyler Wang, Mary Williamson",
188
+ journal={ArXiv},
189
+ year={2023}
190
+ }
191
+ ```