mattjj / pybasicbayes

MIT License
153 stars 60 forks source link

Docstring for public function `sample_gaussian` #56

Open mikewojnowicz opened 3 years ago

mikewojnowicz commented 3 years ago

Thank you for your lovely work.

My question is about sample_gaussian, which is a public function, both by convention (no leading underscore in the function name) and also by usage (it is imported by modules in other python repos).

The latter situation also highlights the importance and utility of this function.

However, there is no docstring.

What is J and what is h? From a quick glance, it seems like these may be related to the natural parameterization -- something along the lines of J being the precision and h being the precision-weighted mean.