diff --git a/README.md b/README.md index ac474e4c79468746e365bb6370716e9ee727bfa0..0be45ea8a7206d9ef6b3d73b1f146ea475ca6895 100644 --- a/README.md +++ b/README.md @@ -81,8 +81,17 @@ Here is a short overview of the stages: - 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```); resulting files are stored in ```exp_*/data/``` -- 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')```); resulting files are stored in ```exp_*/logs/```, ```exp_*/numpy/``` and```exp_*/txt/``` +- 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')```) + - 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/``` -- stage 4: performs a PCA on the similarity matrix and plots the PCA space; 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; resulting ```*.png```-files (confusion matrices) are stored in ```exp_*/plots/kmenas/``` +- stage 4: + - performs a PCA on the similarity matrix and plots the PCA space + - 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 + - resulting ```*.png```-files (confusion matrices) are stored in ```exp_*/plots/kmenas/```