docs: use utilsforecast.evaluation.evaluate in notebooks #1084
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #834
This PR replaces custom
evaluate_performancefunctions and direct metric calls (e.g.,mse(),mae()) with the standardizedutilsforecast.evaluation.evaluatefunction across documentation notebooks.Changes
getting_Started_complete.ipynb
NIXTLA_ID_AS_COL=1env var to ensureunique_idis a column (not index)evaluate_cvimplementation withevaluate(df, metrics=[metric], models=models)getting_Started_complete_polars.ipynb
evaluate()migration (polars already returnsunique_idas column)GARCH_tutorial.ipynb
NIXTLA_ID_AS_COL=1mae(cv_df, models=models)withevaluate(cv_df, metrics=[mae], models=models)CrossValidation.ipynb
NIXTLA_ID_AS_COL=1rmse(cv_df, models=['AutoETS'])withevaluate(cv_df, metrics=[rmse], models=['AutoETS'], agg_fn='mean')Why
NIXTLA_ID_AS_COL?The
cross_validation()andforecast()methods currently return DataFrames withunique_idas the index. Theevaluate()function expectsunique_idas a column. Setting this env var ensures consistent behavior and prepares for the future default whereunique_idwill be a column.Testing
getting_Started_complete.ipynbpasses nbdev_test.notestbut changes follow same pattern