Add guidelines for new algorithms (docs and skeletons) #485
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
albcab
force-pushed
the
developer-doc
branch
from
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
albcab
changed the title
albcab
force-pushed
the
developer-doc
branch
from
5c95c21
to
8b2edea
Compare
albcab
requested review from
rlouf and
junpenglao
and removed request for
rlouf and
junpenglao
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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!