[Minor] Add function to retrieve regressor coefficients - Githubissues

ourownstory / neural_prophet

NeuralProphet: A simple forecasting package

https://neuralprophet.com

MIT License

3.83k stars 473 forks source link

[Minor] Add function to retrieve regressor coefficients #1597

Open Constantin343 opened 3 months ago

Constantin343 commented 3 months ago

:microscope: Background

Make regressor coefficients accessible via a function https://github.com/ourownstory/neural_prophet/issues/1565

:crystal_ball: Key changes

Added a new function to TimeNet Class which helps the user retrieve the coefficients for future regressors, lagged regressors, and events

:clipboard: Review Checklist

[x] I have performed a self-review of my own code.
[x] I have commented my code, added docstrings and data types to function definitions.
[x] I have added pytests to check whether my feature / fix works.

Please make sure to follow our best practices in the Contributing guidelines.

Constantin343 commented 3 months ago

Thanks for the feedback! I wasn't aware that some of the weight calculations were already available and used in the plotting function. I adapted the functions to integrate cleaner with the existing code. The existing plot function didn't seem to work with NN future regressors, so I am using get_future_regressor_coefficients() there now. For the other coefficient calculations I am also using some of the existing code to avoid duplicate functionality.