mod hello world aud

bagustris · Mar 7, 2024 · add883b · add883b
1 parent 8baaaaf
commit add883b
Showing 1 changed file with 25 additions and 23 deletions.
diff --git a/docs/source/hello_world_aud.md b/docs/source/hello_world_aud.md
@@ -6,38 +6,40 @@ Colab](https://colab.research.google.com/drive/1GYNBd5cdZQ1QC3Jm58qoeMaJg3UuPhjw
 and
 [Kaggle](https://www.kaggle.com/felixburk/nkululeko-hello-world-example).
 
-In this setup, we will use the Berlin Emodb dataset. Check the `data/emodb` directory for the dataset and follow the instructions below.
-0. Change the directory to the root of the project.
+In this setup, we will use the Berlin Emodb dataset. Check the `data/emodb` directory for the dataset and follow the instructions below.  
+
+Change the directory to the root of the project.
 
 ```bash
 # Download using wget
-wget https://zenodo.org/record/7447302/files/emodb.zip
+$ wget https://zenodo.org/record/7447302/files/emodb.zip
 # Unzip
-unzip emodb.zip
+$ unzip emodb.zip
 # change to Nkululeko parent directory
-cd ..
+$ cd ..
 # run the nkululeko experiment
-python -m nkululeko.nkululeko --config tests/exp_emodb_os_xgb.ini
+$ python -m nkululeko.nkululeko --config tests/exp_emodb_os_xgb.ini
 ```
 
 Then, check the results in the `results` directory.
 
 You can experiment with changing some paramaters in INI file. For instance, change the `type` of the model to `xgb` or `svm` and see how the results change.
-<!-- -->
 
-    [EXP]
-    root = ./results
-    name = exp_emodb
-    [DATA]
-    databases = ['emodb']
-    emodb = ./emodb/
-    emodb.split_strategy = specified
-    emodb.train_tables = ['emotion.categories.train.gold_standard']
-    emodb.test_tables = ['emotion.categories.test.gold_standard']
-    target = emotion
-    labels = ['anger', 'boredom', 'disgust', 'fear', 'happiness', 'neutral', 'sadness']
-    [FEATS]
-    type = ['os']
-    [MODEL]
-    type = xgb
-    [PLOT]
+```ini
+[EXP]
+root = ./results
+name = exp_emodb
+[DATA]
+databases = ['emodb']
+emodb = ./emodb/
+emodb.split_strategy = specified
+emodb.train_tables = ['emotion.categories.train.gold_standard']
+emodb.test_tables = ['emotion.categories.test.gold_standard']
+target = emotion
+labels = ['anger', 'boredom', 'disgust', 'fear', 'happiness', 'neutral', 'sadness']
+[FEATS]
+type = ['os']
+[MODEL]
+type = xgb
+[PLOT]
+```