Skip to content
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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

albcab
Copy link
Member

@albcab albcab commented Feb 12, 2023

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!

@codecov
Copy link

codecov bot commented Mar 10, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.86%. Comparing base (bc89395) to head (ff87bac).

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.
📢 Have feedback on the report? Share it here.

@gil2rok
Copy link
Contributor

gil2rok commented Feb 21, 2024

Found this guide to be very helpful! I really like the skeleton template code for new samplers!

@albcab albcab changed the title Add developer documentation (design principles, philosopy, objectives and API structure) Add guidelines for new algorithms (docs and skeletons) Feb 22, 2024
@albcab albcab marked this pull request as ready for review February 22, 2024 10:16
@albcab albcab requested review from rlouf and junpenglao and removed request for rlouf and junpenglao February 22, 2024 10:21
@albcab albcab enabled auto-merge (squash) February 22, 2024 10:23
@gil2rok
Copy link
Contributor

gil2rok commented Jun 23, 2024

I saw a small, possible mistake in the VIAlgorithm class documentation that may be relevant here. I described it in #700 .

I also still really like this helpful doc.

@johannahaffner
Copy link
Contributor

Will this be merged and is it still up to date?

@albcab
Copy link
Member Author

albcab commented Jul 24, 2024

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)!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add developer documentation
3 participants