Mirror facebook/wav2vec2-xls-r-300m

Browse files

Files changed (3) hide show

README.md +155 -184
config.json +4 -36
pytorch_model.bin +3 -0

README.md CHANGED Viewed

@@ -1,199 +1,170 @@
 ---
-library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- 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. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-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).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+language:
+- multilingual
+- ab
+- af
+- sq
+- am
+- ar
+- hy
+- as
+- az
+- ba
+- eu
+- be
+- bn
+- bs
+- br
+- bg
+- my
+- yue
+- ca
+- ceb
+- km
+- zh
+- cv
+- hr
+- cs
+- da
+- dv
+- nl
+- en
+- eo
+- et
+- fo
+- fi
+- fr
+- gl
+- lg
+- ka
+- de
+- el
+- gn
+- gu
+- ht
+- cnh
+- ha
+- haw
+- he
+- hi
+- hu
+- is
+- id
+- ia
+- ga
+- it
+- ja
+- jv
+- kb
+- kn
+- kk
+- rw
+- ky
+- ko
+- ku
+- lo
+- la
+- lv
+- ln
+- lt
+- lm
+- mk
+- mg
+- ms
+- ml
+- mt
+- gv
+- mi
+- mr
+- mn
+- ne
+- no
+- nn
+- oc
+- or
+- ps
+- fa
+- pl
+- pt
+- pa
+- ro
+- rm
+- rm
+- ru
+- sah
+- sa
+- sco
+- sr
+- sn
+- sd
+- si
+- sk
+- sl
+- so
+- hsb
+- es
+- su
+- sw
+- sv
+- tl
+- tg
+- ta
+- tt
+- te
+- th
+- bo
+- tp
+- tr
+- tk
+- uk
+- ur
+- uz
+- vi
+- vot
+- war
+- cy
+- yi
+- yo
+- zu
+language_bcp47:
+- zh-HK
+- zh-TW
+- fy-NL
+datasets:
+- common_voice
+- multilingual_librispeech
+tags:
+- speech
+- xls_r
+- xls_r_pretrained
+license: apache-2.0
 ---
+# Wav2Vec2-XLS-R-300M
+[Facebook's Wav2Vec2 XLS-R](https://ai.facebook.com/blog/wav2vec-20-learning-the-structure-of-speech-from-raw-audio/) counting **300 million** parameters.
+![model image](https://raw.githubusercontent.com/patrickvonplaten/scientific_images/master/xls_r.png)
+XLS-R is Facebook AI's large-scale multilingual pretrained model for speech (the "XLM-R for Speech"). It is pretrained on 436k hours of unlabeled speech, including VoxPopuli, MLS, CommonVoice, BABEL, and VoxLingua107. It uses the wav2vec 2.0 objective, in 128 languages. When using the model make sure that your speech input is sampled at 16kHz.
+**Note**: This model should be fine-tuned on a downstream task, like Automatic Speech Recognition, Translation, or Classification. Check out [**this blog**](https://huggingface.co/blog/fine-tune-xlsr-wav2vec2) for more information about ASR.
+[XLS-R Paper](https://arxiv.org/abs/2111.09296)
+Authors: Arun Babu, Changhan Wang, Andros Tjandra, Kushal Lakhotia, Qiantong Xu, Naman Goyal, Kritika Singh, Patrick von Platen, Yatharth Saraf, Juan Pino, Alexei Baevski, Alexis Conneau, Michael Auli
+**Abstract**
+This paper presents XLS-R, a large-scale model for cross-lingual speech representation learning based on wav2vec 2.0. We train models with up to 2B parameters on 436K hours of publicly available speech audio in 128 languages, an order of magnitude more public data than the largest known prior work. Our evaluation covers a wide range of tasks, domains, data regimes and languages, both high and low-resource. On the CoVoST-2 speech translation benchmark, we improve the previous state of the art by an average of 7.4 BLEU over 21 translation directions into English. For speech recognition, XLS-R improves over the best known prior work on BABEL, MLS, CommonVoice as well as VoxPopuli, lowering error rates by 20%-33% relative on average. XLS-R also sets a new state of the art on VoxLingua107 language identification. Moreover, we show that with sufficient model size, cross-lingual pretraining can outperform English-only pretraining when translating English speech into other languages, a setting which favors monolingual pretraining. We hope XLS-R can help to improve speech processing tasks for many more languages of the world.
+The original model can be found under https://github.com/pytorch/fairseq/tree/master/examples/wav2vec#wav2vec-20.
+# Usage
+See [this google colab](https://colab.research.google.com/github/patrickvonplaten/notebooks/blob/master/Fine_Tune_XLS_R_on_Common_Voice.ipynb) for more information on how to fine-tune the model.
+You can find other pretrained XLS-R models with different numbers of parameters:
+* [300M parameters version](https://huggingface.co/facebook/wav2vec2-xls-r-300m)
+* [1B version version](https://huggingface.co/facebook/wav2vec2-xls-r-1b)
+* [2B version version](https://huggingface.co/facebook/wav2vec2-xls-r-2b)

config.json CHANGED Viewed

@@ -1,16 +1,11 @@
 {
   "activation_dropout": 0.0,
-  "adapter_attn_dim": null,
-  "adapter_kernel_size": 3,
-  "adapter_stride": 2,
-  "add_adapter": false,
   "apply_spec_augment": true,
   "architectures": [
-    "Wav2Vec2Model"
   ],
   "attention_dropout": 0.1,
   "bos_token_id": 1,
-  "classifier_proj_size": 256,
   "codevector_dim": 768,
   "contrastive_logits_temperature": 0.1,
   "conv_bias": true,
@@ -45,7 +40,6 @@
   "ctc_zero_infinity": false,
   "diversity_loss_weight": 0.1,
   "do_stable_layer_norm": true,
-  "dtype": "float32",
   "eos_token_id": 2,
   "feat_extract_activation": "gelu",
   "feat_extract_dropout": 0.0,
@@ -62,13 +56,10 @@
   "layer_norm_eps": 1e-05,
   "layerdrop": 0.1,
   "mask_feature_length": 10,
-  "mask_feature_min_masks": 0,
   "mask_feature_prob": 0.0,
   "mask_time_length": 10,
-  "mask_time_min_masks": 2,
   "mask_time_prob": 0.075,
   "model_type": "wav2vec2",
-  "num_adapter_layers": 3,
   "num_attention_heads": 16,
   "num_codevector_groups": 2,
   "num_codevectors_per_group": 320,
@@ -77,32 +68,9 @@
   "num_feat_extract_layers": 7,
   "num_hidden_layers": 24,
   "num_negatives": 100,
-  "output_hidden_size": 1024,
   "pad_token_id": 0,
   "proj_codevector_dim": 768,
-  "tdnn_dilation": [
-    1,
-    2,
-    3,
-    1,
-    1
-  ],
-  "tdnn_dim": [
-    512,
-    512,
-    512,
-    512,
-    1500
-  ],
-  "tdnn_kernel": [
-    5,
-    3,
-    3,
-    1,
-    1
-  ],
-  "transformers_version": "4.56.1",
-  "use_weighted_layer_sum": false,
-  "vocab_size": 32,
-  "xvector_output_dim": 512
 }

 {
   "activation_dropout": 0.0,
   "apply_spec_augment": true,
   "architectures": [
+    "Wav2Vec2ForPreTraining"
   ],
   "attention_dropout": 0.1,
   "bos_token_id": 1,
   "codevector_dim": 768,
   "contrastive_logits_temperature": 0.1,
   "conv_bias": true,
   "ctc_zero_infinity": false,
   "diversity_loss_weight": 0.1,
   "do_stable_layer_norm": true,
   "eos_token_id": 2,
   "feat_extract_activation": "gelu",
   "feat_extract_dropout": 0.0,
   "layer_norm_eps": 1e-05,
   "layerdrop": 0.1,
   "mask_feature_length": 10,
   "mask_feature_prob": 0.0,
   "mask_time_length": 10,
   "mask_time_prob": 0.075,
   "model_type": "wav2vec2",
   "num_attention_heads": 16,
   "num_codevector_groups": 2,
   "num_codevectors_per_group": 320,
   "num_feat_extract_layers": 7,
   "num_hidden_layers": 24,
   "num_negatives": 100,
   "pad_token_id": 0,
   "proj_codevector_dim": 768,
+  "torch_dtype": "float32",
+  "transformers_version": "4.12.0.dev0",
+  "use_weighted_layer_sum": false
 }

pytorch_model.bin ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:d5e490574712ad0a6736923b9ed11d4cd51c78609c36205f704fc4e87b11d2e0
+size 1269737156