From 4cb8818ca63f28faaff37e2ccabfacc53ebefca2 Mon Sep 17 00:00:00 2001
From: "Linke, Julian" <linke@tugraz.at>
Date: Fri, 4 Aug 2023 14:26:04 +0200
Subject: [PATCH] Update file README.md

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 790a842..ab835e5 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:
-- 
GitLab