Documentation scratch plus some minor changes

luke14free / pm-prophet

GAM timeseries modeling with auto-changepoint detection. Inspired by Facebook Prophet and implemented in PyMC3

327 stars 42 forks source link

Documentation scratch plus some minor changes #4

Closed twolodzko closed 6 years ago

twolodzko commented 6 years ago

Changes:

I added a scratch for the documentation (large parts blantly copied from the fbprophet docs),
Fixed a minor bug (there was a if changepoints and changepoints check),
added a licence (MIT is ok?),
fit method now returns self (consistent with sklearn and fbprophet),
I added the requirements.txt file.

Suggestions:

Some of the methods should be re-named into "internal" format (e.g. fit_growth -> _fit_growth) or documented,
Documentation needs improvements (I lack enough understanding of the package yet for this).

twiecki commented 6 years ago

May I suggest Apache v2 instead of MIT to guard against patents?

luke14free commented 6 years ago

@twolodzko I see some issues with this PR as part of the documentation is copied from Prophet but it doesn't really reflect the method's signatures. I also agree on using an Apache2 license.

Also we don't support MAP estimation (by design) or multiplicative seasonality (yet).

twolodzko commented 6 years ago

OK, removed the notion of MAP. The part on multiplicative seasonality was removed even earlier. There also should be no copyright/PR issues with Facebook's Prophet as almost none of it has left after multiple edits.

Still, the docs need many improvements as in many places they are left blank since @luke14free needs to fill them, because my understanding of the code (& future plans) is only partial after just playing with it and not going in-depth into the code.

luke14free commented 6 years ago

👍 absolutely, I'll try to work on your PR now to fix the remaining issues