jeremiecoullon / SGMCMCJax

Lightweight library of stochastic gradient MCMC algorithms written in JAX.
https://sgmcmcjax.readthedocs.io/en/latest/index.html
Apache License 2.0
95 stars 8 forks source link

Functionality documentation, both in docs and in code #30

Closed canyon289 closed 2 years ago

canyon289 commented 2 years ago

I feel this library would benefit from API documentation, detailing

This library would also benefit from code documentation in the codebase itself. For esample here https://github.com/jeremiecoullon/SGMCMCJax/blob/master/sgmcmcjax/kernels.py#L13

Both suggestions could be solved in one shot by documenting the code in a standard documentation format and then using sphinx's automatic API documentation functionality.

Do note this library has excellent examples and applied documentation.

https://github.com/openjournals/joss-reviews/issues/4113

jeremiecoullon commented 2 years ago

Done :)