-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Update docs for 3.1 #1968
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
Comments
Sorry for the silly question but where do we update the sphinx docs - in the docstring itself? |
Use of Generators should be documented too. |
@springcoil yeah, docs/source directory. |
@fonnesbeck https://pymc-devs.github.io/pymc3/api/inference.html#variational ADVI is mentioned in the sphinx docs... However it's not searchable |
I made a first stab at this with these first two examples. |
Would be happy to help with GP docs. Right now the docs, not including the examples or API reference, are the paper on PyMC3. Is the plan to expand this section? Or fix up API docstrings? |
The
|
I see here that approximations are included in docs but they are not displayed anywhere http://pymc-devs.github.io/pymc3/api.html |
I think this can be close now (and open a new one for 3.2 for any remain issue) |
Most of them? :-( |
What are the remaining issues? |
Uh oh!
There was an error while loading. Please reload this page.
I think we need to have the documentation brought up to date with the various innovations that have been introduced to PyMC (including those back in the 3.0 release). There is currently no mention of ADVI in the Sphinx docs, for example. While notebooks are great, they are typically specific examples or use cases, and not a comprehensive documentation of features. There are a few documentation-related issues open that partially cover what needs to be done. A more comprehensive list is as follows:
shared
variables (and other Theano idioms) in PyMC3Bound
Please add to or edit this list. It would be great to make some headway on this in conjunction with the 3.1 release. Perhaps we could organize a "Docs Day" where a few of us knock out drafts of some of this??
The text was updated successfully, but these errors were encountered: