Skip to content

Commit 9a12b69

Browse files
committed
add comment to tutorial
1 parent 9433329 commit 9a12b69

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

docs/tutorials/emulation/01_quickstart.ipynb

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,16 @@
212212
"source": [
213213
"# Choosing an Emulator\n",
214214
"\n",
215-
"From this list, we can choose an emulator based on the index from the summary dataframe, or quickly get the best performing one using the `best_result` function, which picks based on the `r2_test` metric by default. "
215+
"From this list, we can choose an emulator based on the index from the summary dataframe, or quickly get the best performing one using the `best_result` function, which picks based on the `r2_test` metric by default. \n",
216+
"\n",
217+
"<details>\n",
218+
"\n",
219+
"<summary>Choosing a metric for determining the best model</summary>\n",
220+
"\n",
221+
"`metric_name` can be set in the `best_result` method to choose what metric is used to determine the best model: \n",
222+
"\n",
223+
"`ae.best_result(metric_name='rmse')`\n",
224+
"</details>"
216225
]
217226
},
218227
{
@@ -225,16 +234,6 @@
225234
"print(\"Model with id: \", best.id, \" performed best: \", best.model_name)"
226235
]
227236
},
228-
{
229-
"cell_type": "code",
230-
"execution_count": null,
231-
"metadata": {},
232-
"outputs": [],
233-
"source": [
234-
"best = ae.best_result(metric=\"RMSE\")\n",
235-
"print(\"Model with id: \", best.id, \" performed best: \", best.model_name)"
236-
]
237-
},
238237
{
239238
"cell_type": "code",
240239
"execution_count": null,

0 commit comments

Comments
 (0)