Skip to content

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

Closed
10 of 11 tasks
fonnesbeck opened this issue Mar 29, 2017 · 11 comments
Closed
10 of 11 tasks

Update docs for 3.1 #1968

fonnesbeck opened this issue Mar 29, 2017 · 11 comments

Comments

@fonnesbeck
Copy link
Member

fonnesbeck commented Mar 29, 2017

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:

  • ADVI
  • OPVI
  • SVGD
  • Histogram
  • Gaussian processes
  • Use of shared variables (and other Theano idioms) in PyMC3
  • Use of Bound
  • Model selection
  • Update LKJ notebook
  • Generators and minibatch
  • Sampling functionality

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??

@fonnesbeck fonnesbeck added this to the 3.1 milestone Mar 29, 2017
@springcoil
Copy link
Contributor

Sorry for the silly question but where do we update the sphinx docs - in the docstring itself?

@ferrine
Copy link
Member

ferrine commented Mar 29, 2017

Use of Generators should be documented too.

@twiecki
Copy link
Member

twiecki commented Mar 29, 2017

@springcoil yeah, docs/source directory.

@springcoil
Copy link
Contributor

@fonnesbeck https://pymc-devs.github.io/pymc3/api/inference.html#variational ADVI is mentioned in the sphinx docs... However it's not searchable

@springcoil
Copy link
Contributor

I made a first stab at this with these first two examples.

@bwengals
Copy link
Contributor

bwengals commented Apr 1, 2017

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?

@fonnesbeck
Copy link
Member Author

The getting_started document is all there is, outside of the API and the examples. It would be great to have additional sections to cover:

  • Gaussian processes
  • Variational methods
  • Plotting and visualization
  • Modeling strategies

@ferrine
Copy link
Member

ferrine commented Apr 20, 2017

I see here that approximations are included in docs but they are not displayed anywhere http://pymc-devs.github.io/pymc3/api.html
How comes?

@junpenglao
Copy link
Member

I think this can be close now (and open a new one for 3.2 for any remain issue)

@aseyboldt
Copy link
Member

Most of them? :-(

@zaxtax
Copy link
Contributor

zaxtax commented Jul 2, 2017

What are the remaining issues?

@twiecki twiecki modified the milestones: 3.2, 3.1 Jul 2, 2017
@junpenglao junpenglao removed this from the 3.2 milestone Oct 23, 2017
@twiecki twiecki closed this as completed Jan 17, 2018
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

8 participants