Update file README.md

README.md

@@ -15,32 +15,32 @@ Stay tuned for updates and we appreciate your interest in our work. Please conti
 - faiss-cpu (version 1.7.4)
 
 ## Repository structure
-The repository includes a **main script** (```run.sh```), a folder which includes Python scripts (```local/*py```) and an example data folder (```DATA/BEAGR/```). **If you want to work with your own data you would need to prepare a folder on your own which follows a specific folder structure**. 
+The repository includes a **main script** (```run.sh```), a folder which includes Python scripts (```local/*py```) and an example data folder (```DATA/GR/```). **If you want to work with your own data you would need to prepare a folder on your own which follows a specific folder structure**. 
 
-The example data folder includes example files from the BEA corpus (Hungarian) and the GRASS corpus (Austrian German) which makes it possible to run an experiment from scratch. In general, the speech data to be analyzed should be stored in the folder ```DATA/```. In case of the example experiment, this folder (```DATA/BEAGR/```) has the following structure:
+The example data folder includes example files from the BEA corpus (Hungarian) and the GRASS corpus (Austrian German) which makes it possible to run an experiment from scratch. In general, the speech data to be analyzed should be stored in the folder ```DATA/```. In case of the example experiment, this folder (```DATA/GR/```) has the following structure:
 
-- ```DATA/BEAGR/data_BEA_CS```
+- ```DATA/GR/data_BEA_CS```
   - Various speaker (spkID1, spkID2, ...) folders
     - Various .wav or .flac files (fs=16kHz)
-- ```DATA/BEAGR/data_BEA_RS```
+- ```DATA/GR/data_BEA_RS```
   - Various speaker (spkID1, spkID2, ...) folders
     - Various .wav or .flac files (fs=16kHz)
-- ```DATA/BEAGR/data_GR_CS```
+- ```DATA/GR/data_GR_CS```
   - Various speaker (spkID1, spkID2, ...) folders
     - Various .wav or .flac files (fs=16kHz)
-- ```DATA/BEAGR/data_GR_RS```
+- ```DATA/GR/data_GR_RS```
   - Various speaker (spkID1, spkID2, ...) folders
     - Various .wav or .flac files (fs=16kHz)
 
-The example folder ```BEAGR``` (which must be placed in ```DATA/```) sort of defines one experiment and includes the subfolders ```data_BEA_CS``` (BEA Spontaneous Speech), ```data_BEA_RS``` (BEA Read Speech), ```data_GR_CS``` (GRASS Conversational Speech) and ```data_GR_RS``` (GRASS Read Speech). **Please make sure that those folders are named like this: ```data_{corpus}_{speakingstyle}```**. The audio files should have a sampling rate of 16kHz and can be .wav or .flac files. Given this structure and after installing/preparing all dependencies (see below) you should be able to run the experiment. 
+The example folder ```GR``` (which must be placed in ```DATA/```) sort of defines one experiment and includes the subfolders ```data_GR_CS``` (GRASS Conversational Speech) and ```data_GR_RS``` (GRASS Read Speech). **Please make sure that those folders are named like this: ```data_{corpus}_{speakingstyle}```**. The audio files should have a sampling rate of 16kHz and can be .wav or .flac files. Given this structure and after installing/preparing all dependencies (see below) you should be able to run the experiment. 
 
-To run a specific stage of the script for a specific dataset, provide the directory where all your data is stored (here ```DATA/BEAGR/```), an experiment name (here ```BEAGR```) and an integer as an argument to the `./run.sh` command. For instance, to run stage ```3``` for the example dataset ```DATA/BEAGR/``` with the experiment name ```BEAGR```, you would use the following command:
+To run a specific stage of the script for a specific dataset, provide the directory where all your data is stored (here ```DATA/GR/```), an experiment name (here ```GR```) and an integer as an argument to the `./run.sh` command. For instance, to run stage ```3``` for the example dataset ```DATA/GR/``` with the experiment name ```GR```, you would use the following command:
 
 ```
-./run.sh DATA/BEAGR/ BEAGR 3
+./run.sh DATA/GR/ GR 3
 ```
 
-The command automatically generates the experiment folder ```exp_BEAGR```. **Note that stage ```0``` deletes this entire experiment folder (if it exists) and restarts the entire experiment** by running all stages in a row (see below an overview of the stages).
+The command automatically generates the experiment folder ```exp_GR```. **Note that stage ```0``` deletes this entire experiment folder (if it exists) and restarts the entire experiment** by running all stages in a row (see below an overview of the stages).
 
 ## Reproduction
 The following steps are necessary to reproduce the experiment. At first you need to create a conda envrionment and install the necessary packages. Second you have to  clone the fairseq repository and modify the file ```path.sh``` to export necessary environment variables. 
@@ -91,7 +91,7 @@ Here is a short overview of the stages of the main script ```run.sh```:
 
 - ```stage=0```: deletes experiment folder (if it exists) and runs all subsequent stages in a row
 - ```stage=1```: 
-  - prepares the data given an experiment folder (e.g., ```DATA/BEAGR/```)
+  - prepares the data given an experiment folder (e.g., ```DATA/GR/```)
   - resulting files are stored in ```exp_*/data/```
 - ```stage=2```: 
   - counts frequencies of used codebook entries per speaker