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

User Guide #1

Open
antoinecarme opened this issue Oct 13, 2016 · 4 comments
Open

User Guide #1

antoinecarme opened this issue Oct 13, 2016 · 4 comments

Comments

@antoinecarme
Copy link
Owner

At least

  1. API documentation in Python code
  2. Some examples
@antoinecarme
Copy link
Owner Author

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

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

@antoinecarme
Copy link
Owner Author

need a similar doc with hierarchical and grouped time series.

@antoinecarme
Copy link
Owner Author

antoinecarme commented Jan 28, 2017

TODO : Document the algorithmic details of PyAF.

Done :

#35

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

@antoinecarme
Copy link
Owner Author

antoinecarme commented Feb 27, 2023

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant