Skip to content

Commit 7c05589

Browse files
committed
Add to docstring explaining first metric in list is used to pick best model
1 parent 74b451c commit 7c05589

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

autoemulate/core/compare.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,8 @@ def __init__(
134134
Metrics to compute during evaluation.
135135
If None, then defaults to ["r2", "rmse"].
136136
Each entry can be a string shortcut or a MetricConfig object.
137+
IMPORTANT: The first metric in the list is used to
138+
determine the best model.
137139
"""
138140
Results.__init__(self)
139141
self.random_seed = random_seed

0 commit comments

Comments
 (0)