Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
quant5 opened this issue Apr 30, 2024 · 2 comments

Comments

@quant5
Copy link

quant5 commented Apr 30, 2024

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

@jmoralez
Copy link
Member

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.

@quant5
Copy link
Author

quant5 commented Apr 30, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants