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.

Sign up for GitHub

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

Jump to bottom

Add developer guide / internal documentation #47

Open

ClementPinard opened this issue Oct 4, 2024 · 0 comments

Labels

Collaborator

ClementPinard commented Oct 4, 2024 •

edited

Loading

Add internal documentation, made for potential code contributors

It's a way to clearly understand some algorithms applied in the library

For example:

How the dataset object is designed, and why it is currently different from the Evaluator Set
different steps to do before releasing

Inspiration, as always : https://pandas.pydata.org/docs/development/index.html#development
https://docs.pola.rs/development/contributing/

ClementPinard added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment