diff --git a/README.md b/README.md index 790a8421dbea94478b3c7fa1bf7f115e6116cdb8..ab835e5b888636428062ef9a4c55ef48774c8550 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,11 @@ git clone https://github.com/facebookresearch/fairseq.git Make sure to modify the file ```path.sh``` in order to export the necessary environment variables. The file ```path.sh``` is also sourced at the beginning of ```run.sh```. +### Model File +**You need to download and store a model file**. In the main script (```run.sh```) you can specify the ```model_path```. This study is based on the large pretrained model XLSR-53 which can be downloaded here ```https://github.com/facebookresearch/fairseq/blob/main/examples/wav2vec```. + +**Unfortunately loading/initializing the model with version ```fairseq 0.12.2``` lead to errors because of mismatches with respect to dictionary keys. Anyway, we provide a script (```local/create_xlsr_new.py```) which stores a new version of the model preventing those errors. + ### Stages Here is a short overview of the stages: