[minor] add docstring examples

[LeonieFreisinger]

close #1138

🔬 Background

• We would like to add docstring examples for functions that are unclear to call individually to users.

🔮 Key changes

• add example for set_random_seed()
• add example for set_log_level()

📋 Review Checklist

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

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

[github-actions]

Model Benchmark

Benchmark	Metric	main	current	diff
AirPassengers	MAE_val	13.0626	13.0626	0.0%	✅
AirPassengers	RMSE_val	15.9452	15.9453	0.0%	✅
AirPassengers	Loss_val	0.00131	0.00131	0.0%	✅
AirPassengers	MAE	9.88156	9.88156	0.0%	✅
AirPassengers	RMSE	11.7354	11.7354	0.0%	✅
AirPassengers	Loss	0.00052	0.00052	0.0%	✅
AirPassengers	time	5.95916	4.9	-17.77%	🎉
YosemiteTemps	MAE_val	1.3442	1.3442	0.0%	✅
YosemiteTemps	RMSE_val	2.00245	2.00245	0.0%	✅
YosemiteTemps	Loss_val	0.00077	0.00077	0.0%	✅
YosemiteTemps	MAE	1.3192	1.3192	0.0%	✅
YosemiteTemps	RMSE	2.13518	2.13518	0.0%	✅
YosemiteTemps	Loss	0.00064	0.00064	0.0%	✅
YosemiteTemps	time	74.2255	61.31	-17.4%	🎉
PeytonManning	MAE_val	0.58159	0.58159	-0.0%	✅
PeytonManning	RMSE_val	0.72216	0.72216	0.0%	✅
PeytonManning	Loss_val	0.01239	0.01239	-0.0%	✅
PeytonManning	MAE	0.41671	0.41671	-0.0%	✅
PeytonManning	RMSE	0.55961	0.55961	0.0%	✅
PeytonManning	Loss	0.00612	0.00612	0.0%	✅
PeytonManning	time	14.3433	11.96	-16.62%	🎉

Model training plots

Model Training

PeytonManning

YosemiteTemps

AirPassengers

[leoniewgnr]

LGTM

[codecov-commenter]

Codecov Report

Merging #1295 (948d9b2) into main (5e8fa94) will decrease coverage by 0.02%.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main    #1295      +/-   ##
==========================================
- Coverage   89.85%   89.84%   -0.02%     
==========================================
  Files          38       38              
  Lines        5128     5128              
==========================================
- Hits         4608     4607       -1     
- Misses        520      521       +1     

Impacted Files	Coverage Δ
neuralprophet/utils.py	79.35% <ø> (ø)

... and 1 file with indirect coverage changes

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