DOC Improve Documentation via IPython Notebooks

Issue #1 on hold
Mike Hughes repo owner created an issue

It can often be hard just by looking at source code to understand the math update equations. We should use the awesomeness of ipython notebooks to show side-by-side pure math equations (mathjax) and code fragments that implement them.

This can help users understand what different parameters mean, what their bounds are, how to interpret them, useful moments, etc.

At bare minimum we should have a notebook with both math and code for

  • every Distr object
  • every AllocModel object
  • every ObsModel object

Here is an example: https://bitbucket.org/michaelchughes/bnpy-dev/wiki/docs/distr/GaussGammaDistr.rst

Comments (3)

  1. Log in to comment