arm61 / uravu

A straightforward Bayesian data fitting library
https://uravu.readthedocs.io/
MIT License
25 stars 4 forks source link

More under the hood information in docs and tutorials #12

Closed arm61 closed 4 years ago

arm61 commented 4 years ago

In the docs and tutorials, it would be nice to include a little more description of what's going on under the hood when you call various functions since the user interface is purposely designed to ease many of these subtleties. For instance, straight_line and diff_evo seem self-explanatory to me personally, but it would be good to highlight those and other options for users whose first interaction with the code (and possibly Bayesian statistics) will be running through the tutorials in uravu. You do this in some places in later tutorials but not as much earlier, so it'd be good to homogenize a bit.

arm61 commented 4 years ago

closed in #20