statsforecast icon indicating copy to clipboard operation
statsforecast copied to clipboard

Deprecate references to custom `evaluate_performace` function in favor of `utilsforecast.evaluation.evaluate`?

Open quant5 opened this issue 9 months ago • 2 comments

Description

Many instances throughout the statsforecast docs have the user create a custom evaluate_performace function, but there is a perfectly fine one within utilsforecast, which is installed with statsforecast.

https://nixtlaverse.nixtla.io/utilsforecast/evaluation.html

Suggest deprecating references to the custom function in favor of using the evaluate function. Let me know your thoughts.

Link

Instances of the evaluate_performance function code: https://nixtlaverse.nixtla.io/statsforecast/docs/models/autoarima.html#model-evaluation https://nixtlaverse.nixtla.io/statsforecast/docs/tutorials/electricityloadforecasting.html#performance-of-the-mstl-model

...And many others.

Docs of utilsforecast.evaluation.evaluate: https://nixtlaverse.nixtla.io/utilsforecast/evaluation.html

quant5 avatar Apr 30 '24 18:04 quant5

Hey @quant5, thanks for raising this. We're aware of that but that section was copy-pasted so many times that we haven't found the time to fix them all. We'd welcome a contribution if you're interested.

jmoralez avatar Apr 30 '24 19:04 jmoralez

Hey @quant5, thanks for raising this. We're aware of that but that section was copy-pasted so many times that we haven't found the time to fix them all. We'd welcome a contribution if you're interested.

I can work on this and submit a PR. Likely over the weekend.

quant5 avatar Apr 30 '24 20:04 quant5