pyaf icon indicating copy to clipboard operation
pyaf copied to clipboard

User Guide

Open antoinecarme opened this issue 7 years ago • 4 comments

At least

  1. API documentation in Python code
  2. Some examples

antoinecarme avatar Oct 13 '16 16:10 antoinecarme

Added some doc/notebook describing the use of exogenous variables.

https://github.com/antoinecarme/pyaf/blob/master/docs/PyAF_Exogenous.ipynb

antoinecarme avatar Nov 14 '16 14:11 antoinecarme

need a similar doc with hierarchical and grouped time series.

antoinecarme avatar Nov 14 '16 19:11 antoinecarme

TODO : Document the algorithmic details of PyAF.

Done :

https://github.com/antoinecarme/pyaf/issues/35

https://github.com/antoinecarme/pyaf/blob/master/docs/PyAF_Algorithmic_Aspects.ipynb

antoinecarme avatar Jan 28 '17 19:01 antoinecarme

Probably, there will be no user guide.

Expect jupyter notebooks on specific aspects when needed or a new feature is implemented.

It is more suitable to have jupyter notebooks with detailed examples on how to use PyAF for such or such task.

Theoretical aspects are better covered in text books. For PyAF, the reference is still this one (please buy the book, it is constantly updated and improving) :

Forecasting: Principles and Practice (3rd ed) Rob J Hyndman and George Athanasopoulos https://otexts.com/fpp3/ Chinese translation : https://otexts.com/fppcn/

antoinecarme avatar Feb 27 '23 00:02 antoinecarme