Skip to content

Commit af39763

Browse files
authored
Merge pull request #251 from openml/fix246
added docstrings
2 parents c307a19 + 7bf3198 commit af39763

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

openml/runs/trace.py

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ class OpenMLRunTrace(object):
66
Parameters
77
----------
88
run_id : int
9+
OpenML run id
910
1011
trace_iterations : dict
1112
Mapping from key ``(repeat, fold, iteration)`` to an object of
@@ -38,16 +39,25 @@ class OpenMLTraceIteration(object):
3839
Parameters
3940
----------
4041
repeat : int
42+
repeat number (in case of no repeats: 0)
4143
4244
fold : int
43-
45+
fold number (in case of no folds: 0)
46+
4447
iteration : int
48+
iteration number of optimization procedure
4549
46-
setup_string : FIXME
50+
setup_string : str
51+
json string representing the parameters
4752
48-
evaluation : FIXME
53+
evaluation : double
54+
The evaluation that was awarded to this trace iteration.
55+
Measure is defined by the task
4956
50-
selected : FIXME
57+
selected : bool
58+
Whether this was the best of all iterations, and hence
59+
selected for making predictions. Per fold/repeat there
60+
should be only one iteration selected
5161
"""
5262

5363
def __init__(self, repeat, fold, iteration, setup_string, evaluation, selected):

0 commit comments

Comments
 (0)