search

pymc-devs / pymc

Bayesian Modeling and Probabilistic Programming in Python
https://docs.pymc.io/
Other
8.72k stars 2.02k forks source link

PyMC 3 Documentation and User Guides #497

Closed amelio-vazquez-reina closed 10 years ago

amelio-vazquez-reina commented 10 years ago

What is the state of the PyMC 3 documentation? (User Guide, API reference and examples).

I am aware of:

But they are both for PyMC 2.

Besides the PyMC 3 tutorial, are there any documentation, API references or user guides for PyMC 3?

fonnesbeck commented 10 years ago

PyMC 3 is still in alpha, so we have not prepared documentation for public use. We recommend that most users stick to PyMC 2, unless you are interested in testing or contributing. When PyMC 3 is released, there will be complete documentation, and I am working on a book for Bayesian computation that will be based on PyMC 3. So, stay tuned.

As far as examples go, there are several in the pymc/examples directory in the master branch.

amelio-vazquez-reina commented 10 years ago

Thank you @fonnesbeck. That makes sense. One humble suggestion/question: Would it make sense to state something along those lines in the readme.md file, considering that the main view of the PyMC GitHub repository is for PyMC 3? (as a new user of the package, seeing PyMC 3 on the front page of the GitHub repository for PyMC made me think that it was ready for public use). Perhaps a short notice would suffice, at least to prevent first comers from repeating the same question here.

fonnesbeck commented 10 years ago

Done, thanks.