Skip to content

Commit 9405b17

Browse files
committed
Give more concrete description of what a run entails
1 parent 9421f79 commit 9405b17

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/concepts/runs.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ They contain at least a description of the hyperparameter configuration of the F
55
Users may also provide additional metadata related to the experiment, such as the time it took to train or evaluate the model, or their predictive performance.
66
The OpenML server will also compute several common metrics on the provided predictions as appropriate for the task, such as accuracy for a classification task or root mean squared error for regression tasks.
77

8+
For example, [this run](https://www.openml.org/search?type=run&id=10452858&run_flow.flow_id=17691&sort=date) describes an experiment that:
9+
10+
- evaluates a Random Forest pipeline ([flow 17650](https://www.openml.org/f/17650) linked to the task)
11+
- with the configuration `min_samples_leaf=1, n_estimators=500, ...` ([setup 8261828](https://www.openml.org/api/v1/json/setup/8261928) linked to the task)
12+
- in a 10-fold CV experiment ([task 3481](https://www.openml.org/t/3481) linked to the run)
13+
- on dataset "isolet" ([dataset 300](https://www.openml.org/d/300) as described by the task)
14+
- produced predictions in arff format ([predictions.arff](https://www.openml.org/data/download/21829039/predictions.arff))
15+
- several metadata (e.g., metric evaluations) as seen on the run page
16+
817
## Automated reproducible evaluations
918
While the REST API and the OpenML connectors allow you to manually submit Run data, openml-python and mlr3oml also support automated running of experiments and data collection.
1019
The openml-python example below will evaluate the `RandomForestClassifier` on a given task and automatically track information such as the duration of the experiment, the hyperparameter configuration of the model, and version information about the software used in the experiment, and bundle it for convenient upload to OpenML.

0 commit comments

Comments
 (0)