Documentation

[ToluClassics]

Hi @iryna-kondr

Re: Documentation: Improve the project's documentation, including code comments and README files.

I would love to help document this project including code comments and possibly adding some use case notebooks etc.

Let me know if this is something you're open to or if you have some pointers on where to start?

Thanks!

[OKUA1]

Hello @ToluClassics ,

Thank you for showing interest in contributing into scikit-llm.

I would say that the main things regarding the documentation that need to be done are the following (sorted by priority):

• Adding the docstrings
• Extending the documentation + moving it out of readme (as it is getting too big)
• Providing the demo notebooks with real datasets

Right now we are preparing to move scikit-llm out of beta with the next release (which should happen in the next 48 hours), I would say that it is preferable to wait with the documentation until then as we might decide to do some last minute modifications.

[ToluClassics]

Sounds Good!

[OKUA1]

Hey @ToluClassics

Scikit-LLM is out of beta, so it is safe to work on docstrings now as we do not expect major API changes in the near future.

I just wanted to point out, that there is currently an open issue regarding slightly changing the behaviour of the classifier. So, I was thinking that it could be a good idea to coordinate the changes via discord to avoid possible merge conflicts and make sure you do not waste your time on documenting something that is about to change.

Please see my latest comment here: https://github.com/iryna-kondr/scikit-llm/issues/14