Update README.md

Saethox · Dec 11, 2024 · 330ba38 · 330ba38
1 parent 2048b47
commit 330ba38
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -25,6 +25,22 @@ Tested with Python 3.12.
 pip install git+https://github.com/Saethox/iracepy-tiny#egg=irace
 ```
 
+### Usage
+
+```python
+from irace import irace, ParameterSpace, Scenario, Experiment
+
+
+def target_runner(experiment: Experiment, scenario: Scenario) -> float:
+    ...
+
+
+parameter_space = ParameterSpace(...)
+scenario = Scenario(...)
+
+result = irace.irace(target_runner, parameter_space)
+```
+
 ## Examples
 
 See the [examples](./examples) directory.