Skip to content

Commit

Permalink
revise tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
bagustris committed Apr 18, 2024
1 parent 3cf6ce2 commit acdd85a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/source/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ DONE

## Predicting a list of audio files

To predict a list of audio files, you can use `--list' argument. An example is given below. Notice, that you need to specify the relative path of audio file in that list if it is not relative to the current directory. Additonally, you can add`--outfile` argument to save the result to a file.
To predict a list of audio files, you can use `--list` argument. An example is given below. Notice, that you need to specify the relative path of audio file in that list if it is not relative to the current directory. Additonally, you can add`--outfile` argument to save the result to a file.

```bash
(.env) python3 -m nkululeko.demo --config data/ravdess/exp1.ini --list data/ravdess/ravdess_test.csv --folder data/ravdess/ --outfile /tmp/ravdess_test_predict.csv
Expand Down
2 changes: 1 addition & 1 deletion docs/source/hello_world_csv.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hello World with [CSV]
# Hello World [CSV]

In the previous tutorial, we learned how to use Nkululeko with audformat dataset.
Since most dataset are not in audformat, we will learn how to use Nkululeko with pre-processed CSV dataset.
Expand Down
14 changes: 7 additions & 7 deletions docs/source/how_to.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to set up your first nkululeko project
# Nkululeko Workflow

Nkululeko is a framework to build machine learning models that recognize
speaker characteristics on a very high level of abstraction (i.e.
Expand All @@ -7,7 +7,7 @@ starting without programming experience).
This post is meant to help you with setting up your first experiment,
based on the Berlin Emodb.

1) Set up python
1) Set up Python

It's written in python, so first you have to set up a Python environment.
It is recommended to use Linux-based systems for easiness, but it should work on Windows as well.
Expand All @@ -16,10 +16,10 @@ The current version of nkululeko is tested with Python 3.8.5.
2) Get a database

Load the Berlin emodb database to some location on you harddrive, as
discussed in [this post](http://blog.syntheticspeech.de/2021/08/10/get-all-information-from-emodb/). I will refer to the location as "emodb root"
from now on.
discussed in [this post](http://blog.syntheticspeech.de/2021/08/10/get-all-information-from-emodb/).
I will refer to the location as "emodb root" from now on. You can also follow [Hello World page](hello_world_aud.md).

3) Install nkululeko
3) Install Nkululeko

Inside your virtual environment, run:

Expand All @@ -28,7 +28,7 @@ Inside your virtual environment, run:
This should install nkululeko and all required modules. It takes a long
time and a lot of space, when done intially.

5) Adapt the ini file
5) Adapt the INI file

Use your favourite editor, e.g., Visual Studio code and edit the file
that defines your experiment. You might start with this demo sample. You
Expand All @@ -40,7 +40,7 @@ this:

emodb = /home/felix/data/audb/emodb

An overview on all nkululeko options should be here.
An overview on all nkululeko options is listed in [INI file](ini_file).

6) Run the experiment

Expand Down

0 comments on commit acdd85a

Please sign in to comment.