Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
FBurkhardt committed Dec 12, 2023
1 parent 7d70df5 commit 4a1fab6
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- [Documentation](#documentation)
- [Installation](#installation)
- [Usage](#usage)
- [ini-file values](#ini-file-values)
- [Hello World example](#hello-world-example)
- [Features](#features)
- [License](#license)
Expand Down Expand Up @@ -108,7 +109,10 @@ Some examples for *ini*-files (which you use to control nkululeko) are in the [t


## Usage
Basically, you specify your experiment in an "ini" file (e.g. *experiment.ini*) and then call one of the Nkululeko interfaces to run the experiment like this:

### [ini-file values](./ini_file.md)

Basically, you specify your experiment in an ["ini" file](./ini_file.md) (e.g. *experiment.ini*) and then call one of the Nkululeko interfaces to run the experiment like this:
* ```python -m nkululeko.nkululeko --config experiment.ini```

A basic configuration looks like this:
Expand Down

0 comments on commit 4a1fab6

Please sign in to comment.