-
Notifications
You must be signed in to change notification settings - Fork 106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add guidelines for new algorithms (docs and skeletons) #485
base: main
Are you sure you want to change the base?
Conversation
9f1b097
to
9699a45
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #485 +/- ##
=======================================
Coverage 98.86% 98.86%
=======================================
Files 59 59
Lines 2741 2741
=======================================
Hits 2710 2710
Misses 31 31 ☔ View full report in Codecov by Sentry. |
Found this guide to be very helpful! I really like the skeleton template code for new samplers! |
…letons for sampling and approximate inference algorithms
5c95c21
to
8b2edea
Compare
I saw a small, possible mistake in the I also still really like this helpful doc. |
Will this be merged and is it still up to date? |
It should be up to date, but if you find anything outdated, just push a commit (or let me know)! |
Rough draft of the developer docs, closes #235.
I've put some design principles on writing. The idea is to not only write the developer documentation but at the same time evaluate our current API, specify the main objectives of the library and where we want it to be in the future, so that we can think about [if, when and how] we want to restructure.
Opinions, comments, critiques, things I've not considered, etc. are appreciated!