search

TuringLang / AdvancedHMC.jl

Robust, modular and efficient implementation of advanced Hamiltonian Monte Carlo algorithms
https://turinglang.org/AdvancedHMC.jl/
MIT License
228 stars 39 forks source link

ReadMe for consctructors #329

Closed JaimeRZP closed 1 year ago

JaimeRZP commented 1 year ago

Updated ReadMe to explain how to use the constructors. I also spotted a bug in the latest PR and added some tests so it doesn't go unnoticed in the future.

JaimeRZP commented 1 year ago

Thanks a lot @torfjelde. All good my plan is to merge this and make a release so we can bump the version on Turing!

JaimeRZP commented 1 year ago

Good stuff:) Added a few comments.

Also, have we added docs (not in the README, but in docs/) for this?

IMO we should just move all the stuff in the README to docs/ anyways, though this should be done in a separate PR (but in this scenario, it might be worth just moving the section on the convenience contsructors to docs/ maybe?)

Made an issue about it #330