Skip to content
Snippets Groups Projects
Commit bb3f9b86 authored by Linke, Julian's avatar Linke, Julian
Browse files

Update file README.md

parent d0736aac
No related merge requests found
......@@ -15,7 +15,7 @@ Stay tuned for updates and we appreciate your interest in our work. Please conti
- matplotlib
## 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/```). **ATTENTION:** 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/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 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:
......@@ -86,7 +86,7 @@ Here is a short overview of the stages:
- ```stage=2```:
- counts frequencies of used codebook entries per speaker
- if VERBOSE is true this stage also generates log-files
- **ATTENTION:** if you need to extract features with a CPU, set ```device = torch.device('cpu')``` in the script ```local/codebook_freqs.py``` (default is ```device = torch.device('gpu')```)
- **if you need to extract features with a CPU, set ```device = torch.device('cpu')``` in the script ```local/codebook_freqs.py``` (default is ```device = torch.device('gpu')```)**
- resulting files are stored in ```exp_*/logs/```, ```exp_*/numpy/``` and```exp_*/txt/```
- ```stage=3```:
- prepares and stores a similarty matrix in the folder ```exp_*/numpy/```
......@@ -95,6 +95,6 @@ Here is a short overview of the stages:
- resulting ```*.png```-files are stored in ```exp_*/plots/analysis/```
- ```stage=5```:
- performs k-means on the resulting PCA space and assigns classes
- **ATTENTION:** the parameter ```nclust``` in the script ```run.sh``` specifies the number of allowed clusters which should be modified depending on the task
- **the parameter ```nclust``` in the script ```run.sh``` specifies the number of allowed clusters which should be modified depending on the task**
- resulting ```*.png```-files (confusion matrices) are stored in ```exp_*/plots/kmenas/```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment