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

[feature] Add a main script to print neuralprophet version #974

Merged
merged 8 commits into from
Dec 2, 2022

Conversation

noxan
Copy link
Collaborator

@noxan noxan commented Nov 17, 2022

Allows users to run python -m neuralprophet --version and receive the version information of the package directly from their terminal. Could be extended in the future to a cli application of neuralprophet.

@noxan noxan added the status: needs review PR needs to be reviewed by Reviewer(s) label Nov 17, 2022
@codecov-commenter
Copy link

codecov-commenter commented Nov 17, 2022

Codecov Report

Merging #974 (dfd4667) into main (3b6166d) will increase coverage by 0.07%.
The diff coverage is 87.50%.

@@            Coverage Diff             @@
##             main     #974      +/-   ##
==========================================
+ Coverage   89.81%   89.88%   +0.07%     
==========================================
  Files          18       20       +2     
  Lines        4632     4667      +35     
==========================================
+ Hits         4160     4195      +35     
  Misses        472      472              
Impacted Files Coverage Δ
neuralprophet/__main__.py 87.50% <87.50%> (ø)
neuralprophet/plot_forecast_plotly.py 86.82% <0.00%> (-0.77%) ⬇️
neuralprophet/plot_model_parameters_matplotlib.py 90.50% <0.00%> (-0.24%) ⬇️
neuralprophet/time_net.py 89.85% <0.00%> (-0.17%) ⬇️
neuralprophet/df_utils.py 94.72% <0.00%> (ø)
neuralprophet/forecaster.py 88.01% <0.00%> (ø)
neuralprophet/plot_utils.py 89.77% <0.00%> (ø)
neuralprophet/configure.py 90.15% <0.00%> (+0.34%) ⬆️
neuralprophet/utils.py 81.08% <0.00%> (+1.01%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@github-actions
Copy link

github-actions bot commented Nov 17, 2022

9237bfd

Model Benchmark

Benchmark Metric main current diff
YosemiteTemps MAE_val 1.72949 1.72949 0.0%
YosemiteTemps RMSE_val 2.27386 2.27386 0.0%
YosemiteTemps Loss_val 0.00096 0.00096 0.0%
YosemiteTemps RegLoss_val 0 0 0.0%
YosemiteTemps epoch 84 84 0.0%
YosemiteTemps MAE 1.45189 1.45189 0.0%
YosemiteTemps RMSE 2.16631 2.16631 0.0%
YosemiteTemps Loss 0.00066 0.00066 0.0%
YosemiteTemps RegLoss 0 0 0.0%
YosemiteTemps time 102.16 93.2 -8.77%
PeytonManning MAE_val 0.64636 0.64636 0.0%
PeytonManning RMSE_val 0.79276 0.79276 0.0%
PeytonManning Loss_val 0.01494 0.01494 0.0%
PeytonManning RegLoss_val 0 0 0.0%
PeytonManning epoch 37 37 0.0%
PeytonManning MAE 0.42701 0.42701 0.0%
PeytonManning RMSE 0.57032 0.57032 0.0%
PeytonManning Loss 0.00635 0.00635 0.0%
PeytonManning RegLoss 0 0 0.0%
PeytonManning time 12.59 11.79 -6.35%
AirPassengers MAE_val 15.2698 15.2698 0.0%
AirPassengers RMSE_val 19.4209 19.4209 0.0%
AirPassengers Loss_val 0.00195 0.00195 0.0%
AirPassengers RegLoss_val 0 0 0.0%
AirPassengers epoch 89 89 0.0%
AirPassengers MAE 9.82902 9.82902 0.0%
AirPassengers RMSE 11.7005 11.7005 0.0%
AirPassengers Loss 0.00056 0.00056 0.0%
AirPassengers RegLoss 0 0 0.0%
AirPassengers time 4.8 4.46 -7.08%
Model training plots

Model Training

PeytonManning

YosemiteTemps

AirPassengers

@noxan noxan force-pushed the cli-with-main-script-to-print-version branch from dc47a97 to d568df2 Compare November 22, 2022 03:32
@noxan noxan force-pushed the cli-with-main-script-to-print-version branch from e94cfdb to c7e42d2 Compare November 22, 2022 18:34
@noxan noxan changed the title Add a main script to print neuralprophet version [feature] Add a main script to print neuralprophet version Nov 22, 2022
@noxan noxan added this to the Release 0.5.0 milestone Nov 23, 2022
Copy link
Owner

@ourownstory ourownstory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition!
Let's just use the long flag "--version".
Let's remove "-v", which is often used for verbose

@noxan
Copy link
Collaborator Author

noxan commented Nov 24, 2022

@ourownstory Good point. Should we go with -V for version (capital letter) or fully remove the short version?

Feel free to pick your preference from the suggestions below and hope it's good to go then :)

neuralprophet/__main__.py Outdated Show resolved Hide resolved
neuralprophet/__main__.py Outdated Show resolved Hide resolved
@noxan noxan self-assigned this Nov 28, 2022
@karl-richter karl-richter added status: ready PR is ready to be merged and removed status: needs review PR needs to be reviewed by Reviewer(s) labels Dec 2, 2022
@noxan noxan merged commit 9237bfd into main Dec 2, 2022
@noxan noxan deleted the cli-with-main-script-to-print-version branch December 2, 2022 05:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: ready PR is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants